search

coredump-ch / rpsrtsrs

Rock-Paper-Scissors-Real-Time-Strategy game written in Rust.
GNU Affero General Public License v3.0
11 stars 5 forks source link

Add contribution guidelines with 7 commit message rules #60

Closed das-g closed 7 years ago

das-g commented 7 years ago

https://github.com/coredump-ch/rpsrtsrs/pull/59#issuecomment-321495246:

One minor nitpick: Could you start the commit messages with an uppercase letter? I try to follow the recommendations from https://chris.beams.io/posts/git-commit/. I could also change it for you if you don't mind :wink:

Looking through the commit history I noticed that I didn't always follow the recommendations myself :scream:

Well, maybe we need to set up a little reminder for ourselves if we want to stick to these rules.

The linked blogpost recommends to write the rules down, too:

In order to create a useful revision history, teams should first agree on a commit message convention that defines at least the following three things: [...] [...] Spell these things out, remove the guesswork, and make it all as simple as possible.

(emphasis mine)

The right place for this seems to be CONTRIBUTING.md: A link to this file will be displayed by GitHub whenever someone opens a pull request or creates an issue.

rnestler commented 7 years ago

Awesome! Thanks a lot. I wanted to create a CONTRIBUTING.md file anyway and also add some contact info there (IRC channel or similar).