Thank you for your interest in improving Turftopic. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.
Here is a list of important resources for contributors:
Report bugs on the Issue Tracker.
When filing an issue, make sure to answer these questions:
- Which operating system and Python version are you using?
- Which version of this project are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.
Request features on the Issue Tracker.
To install all the development dependencies, run:
$ pip install turftopic[dev]Run the full test suite:
$ pytest tests/Unit tests are located in the tests directory.
Open a pull request to submit changes to this project.
Your pull request needs to meet the following guidelines for acceptance:
- The test suite should ideally pass without errors and warnings.
- Ideally add tests for your changes.
- If your changes add functionality, update the documentation accordingly.
Feel free to submit early, though—we can always iterate on this.
To run code formatting checks before committing your change, you can run either black or ruff.
$ black .
## or
$ ruff .It is recommended to open an issue before starting work on any major changes. This will allow a chance to talk it over with the owners and validate your approach.