synit
/
pmbootstrap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add CONTRIBUTING.md

This commit is contained in:
Oliver Smith 2017-05-28 03:40:30 +02:00
parent 1b9efba2e1
commit c7f8e99fb8
No known key found for this signature in database
GPG Key ID: 5AE7F5513E0885CB
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,12 @@
To contribute, please [fork](https://guides.github.com/activities/forking/) this repository, commit your changes and then make a [pull-request](https://guides.github.com/activities/forking/#making-a-pull-request).
If you have changed Python code, please make sure, that the testsuite runs through. Install `pytest`, then execute `pytest` inside the `pmbootstrap` folder.
Additionally, the [static code analyis script](https://github.com/postmarketOS/pmbootstrap/blob/master/test/static_code_analysis.sh) must run through. Install `shellcheck` and `flake8`, then run:
```
test/static_code_analysis.sh
```
*(As of now, Travis CI can only do the static code analysis. Running the testsuite automatically is planned.)*
**If you need any help, don't hesitate to open an [issue](https://github.com/postmarketOS/pmbootstrap/issues) and ask!**