From ab1bcd2e6f1a8a6632ce62d0db2a497de8f10fad Mon Sep 17 00:00:00 2001 From: Pablo Castellano Date: Mon, 14 Aug 2017 16:23:35 +0200 Subject: [PATCH] contributing: fixed typos and added some links (#372) --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index faf643a0..64ec4aed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,20 @@ ## Reporting issues * Consider joining the [chat](https://github.com/postmarketOS/pmbootstrap/wiki/Matrix-and-IRC) for instant help. -* Maybe your question is answered in the [wiki](https://github.com/postmarketOS/pmbootstrap/wiki) somewhere. +* Maybe your question is answered in the [wiki](https://github.com/postmarketOS/pmbootstrap/wiki) somewhere. [Search](https://github.com/postmarketOS/pmbootstrap/search?q=&type=Wikis&utf8=%E2%9C%93) first! * Otherwise, just ask what you want to know. We're happy if we can help you and glad that you're using `pmbootstrap`! ## Development +See pmbootstrap's [Development Guide](https://github.com/postmarketOS/pmbootstrap/wiki/Development-guide). + ### Contributing code changes * [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) (PR). * Please test your code before submitting a PR. ### Shell scripting -* We don't write scipts for `bash`, but for `busybox`'s `ash` shell, which is POSIX compliant (plus very few features from `bash`). +* We don't write scripts for `bash`, but for `busybox`'s `ash` shell, which is POSIX compliant (plus very few features from `bash`). * Use `shellcheck` to test your changes for issues before submitting. There is even an [online](https://www.shellcheck.net) version. -* We're looking into automatizing this more, some files already get checked automatically by the [static code analyis script](https://github.com/postmarketOS/pmbootstrap/blob/master/test/static_code_analysis.sh). +* We're looking into automatizing this more, some files already get checked automatically by the [static code analysis script](https://github.com/postmarketOS/pmbootstrap/blob/master/test/static_code_analysis.sh). ### Python * We use the [PEP8](https://www.python.org/dev/peps/pep-0008/) standard for Python code. Don't worry, you don't need to read all that, just run the `autopep8` program on your changed code, and confirm with the [static code analyis script](https://github.com/postmarketOS/pmbootstrap/blob/master/test/static_code_analysis.sh) that everything is PEP8 compliant. *This script will run automatically on Travis CI when you make a change request, and it must pass for your code to get accepted.* @@ -27,7 +29,7 @@ This is a reST style. :raises keyError: raises an exception """ ``` -* If it is feasible for you, try to run the testsuite on code that you have changed. the `test/test_build.py` case will build full cross-compilers for `aarch64` and `armhf`, so it may take a long time. Testcases can be started with `pytest` and it's planned to run that automatically when making a new PR (see [#64](https://github.com/postmarketOS/pmbootstrap/issues/64)). +* If it is feasible for you, try to run the testsuite on code that you have changed. The `test/test_build.py` case will build full cross-compilers for `aarch64` and `armhf`, so it may take a long time. Testcases can be started with `pytest` and it's planned to run that automatically when making a new PR (see [#64](https://github.com/postmarketOS/pmbootstrap/issues/64)). **If you need any help, don't hesitate to open an [issue](https://github.com/postmarketOS/pmbootstrap/issues) and ask!**