platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-10-04 01:20:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
dae3b9665b6d99989477c9efc12d1ccad8297141
platformio-core/CONTRIBUTING.md
Kalle Bracht f3d26fae64 Removing inconsistent dot at README.rst, HISTORY.rst and CONTRIBUTING.md (#4172) 
* Removing inconsistent dot at README list

* Removing inconsistent dot at HISTORY file

* Removing inconsistent dot at CONTRIBUTING file
2022-02-07 13:45:56 +02:00

874 B
Raw Blame History

Contributing

To get started, sign the Contributor License Agreement.

  1. Fork the repository on GitHub

  2. Clone repository git clone --recursive https://github.com/YourGithubUsername/platformio-core.git

  3. Run pip install tox

  4. Go to the root of project where is located tox.ini and run tox -e py37

  5. Activate current development environment:

    • Windows: .tox\py37\Scripts\activate
    • Bash/ZSH: source .tox/py37/bin/activate
    • Fish: source .tox/py37/bin/activate.fish

  6. Make changes to code, documentation, etc.

  7. Lint source code make before-commit

  8. Run the tests make test

  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