Skip to content

Commit 7e1151a

Browse files
Lauric Desauwaltor
Lauric Desauw
authored andcommitted
doc: add contribution guide
1 parent 9db51a1 commit 7e1151a

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

contributing.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to PowerAPI
2+
3+
Thank you for your interest in contributing to PowerAPI! There are multiple ways to contribute, and we appreciate all contributions.
4+
5+
# Ways to contribute
6+
7+
Pull requests should be made on the pre-release branch. This way they will be
8+
included in the next stable release (available on master).
9+
Each pull request should pass the tests and be correctly linted to pass the CI.
10+
11+
Each pull request have to be reviewed before beeing accepted. Some modifications can be
12+
asked by the projet's managers.
13+
14+
Here is different ways to contribute to PowerAPI.
15+
16+
## Bug report
17+
18+
If you are working with PowerAPI and you encounter a bug, please let us know.
19+
You are welcome to submit an issue which describe the bug and it context with a
20+
small test or a code snippet that reproduce the issue.
21+
22+
## Bug Fixes
23+
24+
If you are interested to contribute to PowerAPI you can fixes reported bugs.
25+
They are listed in the issues with the label _bug_
26+
27+
Your pull request should contain a test that reproduce the bug, if the test do
28+
not already exist, and the bug fix.
29+
Please submit one pull request for each bug fix.
30+
31+
## Patches
32+
33+
You can submit bigger contributions in the form of patches.
34+
A patch should :
35+
36+
- include unit tests
37+
- be an isolated changes. If you have uncorelated changes you should submit multiple pull requests to make it easier for us to review

0 commit comments

Comments
 (0)