mirror of
https://github.com/i3/i3.git
synced 2026-08-18 02:52:38 +00:00
CONTRIBUTING: discourage Conventional Commits in favor of scope (#6630)
I recently came across this blog post which has put into words how I felt about Conventional Commits for a while. Let’s reference it.
This commit is contained in:
committed by
GitHub
parent
8f09b7f046
commit
f7d5b8983f
3
.github/CONTRIBUTING.md
vendored
3
.github/CONTRIBUTING.md
vendored
@ -68,6 +68,9 @@ Here are a few examples for illustration:
|
||||
* Use the `next` branch for developing and sending your pull request.
|
||||
* Use `clang-format` to format your code.
|
||||
* Run the [testsuite](https://i3wm.org/docs/testsuite.html)
|
||||
* When giving your commit a title, do not use Conventional Commits (“refactor: …”),
|
||||
instead prefix the commit with the scope of what it changes (“pointer warping: …”):
|
||||
https://sumnerevans.com/posts/software-engineering/stop-using-conventional-commits/
|
||||
* If your changes should be reported on the next release's changelog, also
|
||||
add a small single-line file starting with a number (see examples) containing
|
||||
a short explanation of your change either in the
|
||||
|
||||
Reference in New Issue
Block a user