Skip to content

Commit 533ba1c

Browse files
committed
Define workflow
Import from engine
1 parent d1da8d6 commit 533ba1c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,46 @@ Before you begin coding and collaborating, please read our [Code of Conduct](./C
1212

1313

1414

15+
## Workflow
16+
17+
### Pull requests
18+
19+
We follow the [GitHub Flow](https://guides.github.com/introduction/flow/): all contributions are submitted via a pull request towards the `main` branch.
20+
21+
Opening a pull request means you want that code to be merged. If you want to only discuss it, send a link to your branch along with your questions through whichever communication channel you prefer.
22+
23+
#### Peer reviews
24+
25+
All pull requests must be reviewed by at least one person who is not their original author.
26+
27+
To help reviewers, make sure to describe your pull request with a **clear text explanation** of your changes.
28+
29+
For pull requests of new contributors, if errors or areas for improvement are identified in their contributions, the Open Terms Archive team can initially handle them. This is intended to speed up the delivery process and help the contributor acclimatise to the project. As they become more involved and learn more, they will be encouraged to take on more responsibility by implementing the changes themselves. The aim is to support growth and confidence in the contribution to the project while promoting quick delivery.
30+
31+
### Continuous delivery
32+
33+
GitHub Actions is used to publish the documentation on every merge to the main branch.
34+
35+
Branch protection is active, meaning that a merge to the main branch can only take place once all tests pass in CI, and that the peer review policy has been fulfilled.
36+
37+
### Commit messages
38+
39+
We strive to follow this [recommendation](https://chris.beams.io/posts/git-commit) to write our commit messages, which contains the following rules:
40+
41+
- [Separate subject from body with a blank line](https://chris.beams.io/posts/git-commit/#separate).
42+
- [Limit the subject line to 50 characters](https://chris.beams.io/posts/git-commit/#limit-50).
43+
- [Capitalize the subject line](https://chris.beams.io/posts/git-commit/#capitalize).
44+
- [Do not end the subject line with a period](https://chris.beams.io/posts/git-commit/#end).
45+
- [Use the imperative mood in the subject line](https://chris.beams.io/posts/git-commit/#imperative).
46+
- [Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how).
47+
48+
Except this one:
49+
50+
- ~~[Wrap the body at 72 characters](https://chris.beams.io/posts/git-commit/#wrap-72)~~: As URLs might be used for references in commit messages, the body text is not wrapped to 72 characters to ensure links are clickable in Git user interfaces.
51+
52+
We add these additional rules:
53+
54+
- Do not rely on GitHub issue reference numbers in commit messages, as we have no guarantee the host system and its autolinking will be stable in time. Make sure the context is self-explanatory. If an external reference is given, use its full URL.
1555

1656
## List contributors in the Open Terms Archive website
1757

0 commit comments

Comments
 (0)