doc: add examples in commit message guidelines #131
Conversation
haxscramper
force-pushed
the
code-guides-2
branch
2 times, most recently
from
ef0ac47 to
97b60c5
Compare
| seeing if old issues can be closed with recent changes | ||
|
|
||
|
|
||
| Message examples |
There was a problem hiding this comment.
Specific examples are up to debate, and I think having more would be beneficial. For now I added a simple example, in future this will be expanded
| The `git`:cmd: stuff | ||
| ==================== | ||
|
|
||
| PR should contain a single commit |
There was a problem hiding this comment.
More elaborate explanation about reasons and solutions to the "single commit" rule, also need to be checked for sanity.
| @@ -45,6 +45,17 @@ Code reviews | |||
| When reviewing code it is highly recommended to check whether it complies | |||
| with official style guide and point out mismatches. | |||
|
|
|||
| Prepared replies | |||
There was a problem hiding this comment.
More replies need to be added here, for now I only added one that links to the commit message guidelines
haxscramper
force-pushed
the
code-guides-2
branch
6 times, most recently
from
edc7f15 to
f5d8112
Compare
|
|
||
| .. code:: | ||
|
|
||
| Fixes https://github.com/nim-lang/Nim/issues/19051 |
There was a problem hiding this comment.
| Fixes https://github.com/nim-lang/Nim/issues/19051 | |
| Fixes https://github.com/nim-works/nimskull/issues/19051 |
There was a problem hiding this comment.
That one should retain the original url, we don't have a 19k issues at the moment
| - If you need to made some additional modifications (review requested) you | ||
| can extend the commit and force-push it (`git commit --amend | ||
| --no-edit`:cmd: and `git push --force <remote> <your branch>`:cmd:) | ||
| - Create multiple commits and then squash them when your pull request is |
There was a problem hiding this comment.
Can we elevate this one, it's a nicer flow and less frustrating. It's one of those things where people don't realize they can do this.
There was a problem hiding this comment.
It is more frustrating to do right now, requires digging into multistep git stuff create an intermediate branch. Extending the same commit and force-pushing it is much easier, especially for a small changes, where you just need to correct a couple of lines.
Add more elaborate examples in the commit message guidelines and pull requests. Provide reasoning and reformat rules
haxscramper
force-pushed
the
code-guides-2
branch
from
f5d8112 to
d49d943
Compare
|
bors r+ |
|
Build succeeded: |
Add more elaborate examples in the commit message guidelines and pull
requests. Provide reasoning and reformat rules