Contributing to Foxcross
To submit new code to the project you'll need to:
- Fork the repo
- Clone your fork on your local computer:
git clone https://github.com/<username>/foxcross.git
- Install poetry for managing dependencies
- Install Foxcross locally:
poetry install
- Run the basic test suite:
pytest tests/test_serving.py tests/test_failed_serving.py tests/test_no_extra.py
- Install the linters:
pre-commit install
- Create a branch off of
develop
for your work:git checkout develop
git checkout -b <branch-name>
- Make your changes
- Add any tests or documentation necessary
- Push to your remote:
git push origin <branch-name>
- Open a pull request