From c7f8e99fb85ab50bc1e2c91aad6c1bfb8ab3745a Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Sun, 28 May 2017 03:40:30 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e4be6a91 --- /dev/null +++ b/CONTRIBUTING.md @@ -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!**