We welcome contributions to this project!
If you have an idea for a new feature or improvement, please open an issue to discuss it with the community before submitting a pull request.
Here are some guidelines to follow when contributing:
- Before making a contribution, please check the project's open issues to see if someone else is already working on something similar. If you have a new suggestion >or have found a bug, please open a new issue to let us know.
- If you want to work on an existing issue or have a new idea for a feature, please comment on the issue to let us know that you are working on it. This will help to > prevent duplication of effort.
- All contributions should be made via pull request. When submitting a pull request, please make sure to include a clear description of the changes you have made and why they are necessary.
- All code contributions should be accompanied by tests to ensure that the changes do not break existing functionality.
- If you are making a non-code contribution (e.g. writing documentation, creating graphics), please make sure to follow the project's style guidelines and include any necessary attribution.
- Fork the repository.
- Create a new branch for your changes.
- Make your changes. Make sure all changes are documented using docstrings and use pdoc3 to generate documentation files.
- Push your changes to your forked repository.
- Submit a pull request to the main repository.
Use pdoc3 to generate documentation
pip install pdoc3
In the project root directory:
pdoc3 -o docs sportsbooklib