Skip to content

Commit 168f703

Browse files
Andrei PashkinAndrei Pashkin
Andrei Pashkin
authored and
Andrei Pashkin
committed
Add contribution guidelines.
This is the initial version of a contribution guidelines document, it provides brief intructions aimed to establish unified contribution process.
1 parent 019008e commit 168f703

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.rst

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
=======================
2+
Contribution guidelines
3+
=======================
4+
These guidelines are aimed to ease code review process and establish unified
5+
contribution process.
6+
7+
Submitting changes
8+
------------------
9+
- Fork and clone the repository.
10+
- Make a branch off of `master` branch.
11+
- When ready - push the branch and create a pull request to `master` branch.
12+
- Make sure that the CI build passes.
13+
14+
Making commits
15+
--------------
16+
- Split your logically separate changes into separate commits.
17+
- Split formatting changes into separate commits.
18+
- Provide detailed descriptions for your commits so it would be easier for
19+
the other contributors to review/investigate the code written by you.
20+
- The commit messages must be formatted in Linux-style way:
21+
* Summary line no longer than 50-75 characters.
22+
* Blank line.
23+
* Explanation body wrapped at 75 columns.
24+
25+
Code review
26+
-----------
27+
- At least 2 developers from the core team must approve a pull request before
28+
it could be merged.
29+
30+
Branching strategy
31+
------------------
32+
- The main branch is `master`.
33+
- Contributors create topic branches for each bugfix/feature/etc off of `master`
34+
and merge them back to `master`.
35+
- At a release time - a release branch is made.
36+
- To backport a change to a release-branch - it first must be committed to
37+
`master` branch or a relevant release-branch and then cherry-picked to
38+
older release-branches.
39+
- Each release must be tagged.

0 commit comments

Comments
 (0)