Contributing

Commit Guideline

Don’t forget to set your name and email

How can I change the author name / email of a commit? https://www.git-tower.com/learn/git/faq/change-author-name-email

$ git config user.name "John Doe"
$ git config user.email "john@doe.org"

Commit Messages

A good commit message tells others what you did at a glance.

Without a good commit message, others have to look at all changes of your commit to judge whether some of them are relevant to their work.

We roughly follow the “The seven rules of a great Git commit message” of this blog post: How to Write a Git Commit Message.

More specific, in descending order of importance:

1. Use the imperative mood in the subject line

2. Use the body to explain what and why vs. how (how is better explained in source code/comments)

3. Capitalize the subject line

4. Do not end the subject line with a period

5. Separate subject from body with a blank line (if there’s need for more than one line)

For examples, check the blog post or the history of the repository.