Skip to content

Commit 839e45a

Browse files
committed
docs: update commit requirements for contributors
Update CONTRIBUTING.md with a link to Victoria Dye's recent talk on crafting logical, well-ordered commit messages. Move this link into the 'Submitting a pull request' section so that new contributors are more likely to see it while following the prescribed steps.
1 parent 9d827ff commit 839e45a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[fork]: https://github.com/GitCredentialManager/git-credential-manager/fork
55
[pr]: https://github.com/GitCredentialManager/git-credential-manager/compare
66
[code-of-conduct]: CODE_OF_CONDUCT.md
7+
[commits]: https://www.youtube.com/watch?v=4qLtKx9S9a8
78

89
Hi there! We're thrilled that you'd like to contribute to GCM :tada:. Your help is essential for keeping it great.
910

@@ -29,6 +30,7 @@ This helps us coordinate and reduce duplication.
2930
- `GitHub.UI.Avalonia`
3031
- `Atlassian.Bitbucket.UI.Windows`
3132
- `GitHub.UI.Windows`
33+
1. Organize your changes into one or more [logical, descriptive commits][commits].
3234
1. Push to your fork and [submit a pull request][pr]
3335
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
3436

@@ -37,7 +39,6 @@ Here are a few things you can do that will increase the likelihood of your pull
3739
- Match existing code style.
3840
- Write tests.
3941
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
40-
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
4142

4243
## Resources
4344

0 commit comments

Comments
 (0)