Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 1016 Bytes
Raw

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 the PlatformIO Core project where tox.ini is located (cd platformio-core) and run tox -e py39. You can replace py39 with your own Python version. For example, py311 means Python 3.11.

  5. Activate current development environment:

    • Windows: .tox\py39\Scripts\activate
    • Bash/ZSH: source .tox/py39/bin/activate
    • Fish: source .tox/py39/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