Update Contribution guidelines and PR template #2575
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
waldyrious
changed the title
waldyrious
force-pushed
the
contributing-commit-msgs
branch
from
8d35870 to
78449fe
Compare
5 tasks
owenvoke
approved these changes
Nov 10, 2018
agnivade
reviewed
Nov 12, 2018
sbrl
approved these changes
Nov 12, 2018
Member
sbrl
left a comment
sbrl
left a comment
There was a problem hiding this comment.
Looks great, @waldyrious! Much briefer than our existing template.
- Add example commit messages for translations and for changes that affect multiple pages; - Prefix each example with a description of the type of change it refers to.
- Remove horizontal rule at the top (the comments are sufficient as visual separation); - Shorten the comments to make them more compact and more likely to be read; - Make each checklist entry take a single line; - Remove blank lines between checklist entries.
waldyrious
force-pushed
the
contributing-commit-msgs
branch
from
78449fe to
6ec81b2
Compare
Member
Author
agnivade
approved these changes
Nov 13, 2018
Member
Author
|
Please don't merge yet, I need to fix the issue @pxgamer pointed out in the review comments. |
Member
Author
|
Update: I've confirmed the current URL format works as intended (see the inline conversation above for details). Feel free to merge this. |
Member
Author
|
Oh no, @pxgamer, you squash-merged my carefully crafted separate commits 😢 Not a big deal of course :) but in the future, please keep in mind the second-to-last bullet point here when merging PRs. |
2 tasks
Member
|
Ah, damn it. I apologise, I completely forgot about commit history. |
Member
Author
|
No problem! 😃 this sort of thing is better gradually acquired as part of the development culture/process, rather than by memorizing rules exhaustively. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the commit message guidelines in CONTRIBUTING.md:
It also updates the PR template, to make it more compact and reduce duplication of information included in CONTRIBUTING.md:
(the comments are sufficient as visual separation);
This is a follow-up to the discussion at #2512.