2016-07-10 19:15:55 +03:00
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
2020-05-01 23:37:38 +03:00
|
|
|
To get started, <a href="https://cla-assistant.io/platformio/platformio-core">sign the Contributor License Agreement</a>.
|
2016-07-10 19:15:55 +03:00
|
|
|
|
2022-02-07 12:45:56 +01:00
|
|
|
1. Fork the repository on GitHub
|
2019-07-24 12:08:21 +03:00
|
|
|
2. Clone repository `git clone --recursive https://github.com/YourGithubUsername/platformio-core.git`
|
|
|
|
|
3. Run `pip install tox`
|
2020-05-01 23:37:38 +03:00
|
|
|
4. Go to the root of project where is located `tox.ini` and run `tox -e py37`
|
2016-07-10 19:15:55 +03:00
|
|
|
5. Activate current development environment:
|
|
|
|
|
|
2020-05-01 23:37:38 +03:00
|
|
|
* Windows: `.tox\py37\Scripts\activate`
|
|
|
|
|
* Bash/ZSH: `source .tox/py37/bin/activate`
|
|
|
|
|
* Fish: `source .tox/py37/bin/activate.fish`
|
2016-07-10 19:15:55 +03:00
|
|
|
|
|
|
|
|
6. Make changes to code, documentation, etc.
|
2020-05-01 23:37:38 +03:00
|
|
|
7. Lint source code `make before-commit`
|
2019-07-24 12:08:21 +03:00
|
|
|
8. Run the tests `make test`
|
|
|
|
|
9. Build documentation `tox -e docs` (creates a directory _build under docs where you can find the html)
|
2016-07-10 19:15:55 +03:00
|
|
|
10. Commit changes to your forked repository
|
2022-02-07 12:45:56 +01:00
|
|
|
11. Submit a Pull Request on GitHub
|
