Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 817 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (15 loc) · 817 Bytes
Raw

Contributing

Help Steps

  1. Fork the repository
  2. Clone the repository (git clone https://github.com/username/clashroyale)
  3. Checkout in a new branch (git checkout -b feature-name)
  4. Install all test dependencies (pip install -r tests/requirements.txt)
  5. Make the necessary edits
  6. Add the necessary tests in the tests folder
  7. Add the necessary documentation and docstrings
  8. Add the necessary points to CHANGELOG.md
  9. Fill up the tests/.env file with the suitable tokens
  10. Run flake8 from the root folder (there are certain ignored errors defined in tox.ini)
  11. Run tox from the root folder and ensure the tests are configured correctly and they return OK. RoyaleAPI SeverErrors can be disregarded.
  12. Open your PR :)

Do not increment version numbers but update CHANGELOG.md.