From 581fd356cd77dbb56b2510e7bf2f926e80e5ba11 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Sun, 10 Jul 2016 19:15:55 +0300 Subject: [PATCH] Add contributing guidelines --- CONTRIBUTING.md | 21 +++++++++++++++++++++ README.rst | 17 +---------------- 2 files changed, 22 insertions(+), 16 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e46d388c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +Contributing +------------ + +To get started, sign the Contributor License Agreement. + +1. Fork the repository on GitHub. +2. Make a branch off of ``develop`` +3. Run ``pip install tox`` +4. Go to the root of project where is located ``tox.ini`` and run ``tox -e develop`` +5. Activate current development environment: + + * Windows: ``.tox\develop\Scripts\activate`` + * Bash/ZSH: ``source .tox/develop/bin/activate`` + * Fish: ``source .tox/bin/activate.fish`` + +6. Make changes to code, documentation, etc. +7. Lint source code ``tox -e lint`` +8. Run the tests ``tox -e py27`` +9. Build documentation ``tox -e docs`` (creates a directory _build under docs where you can find the html) +10. Commit changes to your forked repository +11. Submit a Pull Request on GitHub. diff --git a/README.rst b/README.rst index 391214f2..44ad2e5b 100644 --- a/README.rst +++ b/README.rst @@ -185,22 +185,7 @@ For further details, please refer to `What is PlatformIO? `_. Licence -------