contributing

To contribue please open a pull request on the GitHub repository with a summary of your changes.

Alternatively you can support me on Ko-Fi and watch me stream on YouTube

Important

Before you contribute it is highly recommended that you join the Discord server to discuss your changes with the community. Please also start a discussion on the code you are working on. This will help you to avoid wasting your time on a pull request that somebody else has been working on.

How To Contribute

  1. Fork the repository.

  2. Make your changes.

  3. Your code should automatically test itself on push back to GitHub. It should also build the documentation, please ensure your tests are passing before making a pull request as it will be instantly closed if they are not.

  4. Make a pull request.

Note

If, for whatever reason your tests are not passing on GitHub, you can run them locally. Please read below.

Running Tests Locally

  1. Install the following packages.

pip3 install pytest
pip3 install sphinx
pip3 install sphinx_rtd_theme

  1. Run pytest test_pyfl/test.py in the root directory.

  2. Run sphinx-apidoc -o docs/source/ src/pyfl/ in the route directory.

  3. Run make html in the docs folder.

Warning

Please ensure that you add your api key to the env file before running the tests. If you do not, the tests will fail.