diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2dd09d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to nhl-api-py + +Thank you for considering contributing to nhl-api-py! We appreciate your time and effort in helping us improve the package. The following guidelines will help you understand how to contribute effectively. + +## How to Contribute + +1. Fork the repository and create a new branch for your contributions. +2. Make your changes, enhancements, or bug fixes in the new branch. +3. Test your changes locally to ensure they are functioning as expected. +4. Commit your changes with clear and descriptive messages. +5. Push your changes to your forked repository. +6. Create a pull request (PR) from your branch to the main repository. + +## Guidelines for Contributions + +- Before starting any significant work, please open an issue or join an existing discussion to ensure that your contribution aligns with the project's goals and avoids duplication of effort. +- Follow the Python style guide (PEP 8) when writing or modifying code. Maintain consistent code formatting and ensure your changes pass the linting checks. +- Include unit tests to validate the changes you've made. Ensure that all existing tests pass successfully. +- Document any new features, modifications, or bug fixes using the appropriate format in the code and/or in the project's documentation. +- Be responsive to any feedback or comments on your pull request and make necessary updates as requested. +- Respect the code of conduct. Be considerate, inclusive, and respectful in all interactions and communications. + +## Issue Reporting + +If you encounter any issues, bugs, or have suggestions for improvements, please open a GitHub issue. When reporting an issue, provide as much relevant information as possible, including the steps to reproduce the problem. + +## Feature Requests + +If you have ideas for new features or enhancements, we encourage you to open an issue on GitHub. Explain your feature request in detail, including its purpose and potential benefits. + +## Code of Conduct + +By participating in this project, you are expected to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md). Please familiarize yourself with it and ensure that all interactions are respectful and inclusive. + +## Licensing + +Contributions to nhl-api-py are subject to the same license as the main repository. By contributing code, you agree to license your contributions under the project's existing license.