Skip to content

Commit

Permalink
Extend and improve the contribution rules
Browse files Browse the repository at this point in the history
  • Loading branch information
jeltsch committed Jul 16, 2023
1 parent daaed2c commit 1d01ec9
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
Commit rules
============
Rules for branches
==================

When committing to this repository, please follow these rules:
* Use a branch name of the form `⟨type⟩/⟨topic⟩`. Here, `⟨type⟩`
refers to the type of contribution as given by the label of the form
`type: ⟨type⟩` of the pull request associated with the branch.

* For the `⟨topic⟩` part of the branch name, use only lowercase Latin
letters, Arabic numerals, and ASCII dashes, with the latter also
serving as separators of words.


Rules for commits[^original-commit-rules]
=========================================

* Put only related changes into a single commit.

Expand Down Expand Up @@ -38,5 +48,6 @@ When committing to this repository, please follow these rules:
Here, `⟨branch⟩` refers to the name of the branch without the GitHub
account name component.

Several of these rules have been taken from
https://chris.beams.io/posts/git-commit/#seven-rules.
[^original-commit-rules]:
Several of these rules have been taken from
https://chris.beams.io/posts/git-commit/#seven-rules.

0 comments on commit 1d01ec9

Please sign in to comment.