Skip to content

Commit

Permalink
doc: refine contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jfilak committed Apr 9, 2024
1 parent 4fdef1e commit 229d58a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,19 @@ explanatory.
3. Create commits for logical changes - it is better to create more commits
than less

4. Use the short commit message to provide an apt description of the change.
Write the short message in the imperative, present tense.

5. Use the commit message body to explain your motivation and document your
thinking process (to put it simple - care to explain "why"). Everybody can
see the changes made, so do not try to summarize them unless you changed
dozens of files. In the case you change visible output, it is a good idea to
provide current version and the new one.

4. Open a pull request - if you see Merge commits in your PR, you did something
wrong, so please try to get rid of them

5. Check Travis build results
5. Check GitHub Actions builder

6. In case of build failures, please, **amend your commits** - IOW try to avoid adding
new commits fixing your commits to your pull request
Expand Down

0 comments on commit 229d58a

Please sign in to comment.