We appreciate your efforts and contributions to make this project better.
Please take a moment to review this document in order to make the contribution process smooth and effective for everyone involved.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.
If you encounter a bug, please create an issue on our GitHub issue tracker with detailed information about the problem. Your feedback is valuable and will help us improve.
We also welcome suggestions for enhancements. Feel free to open an issue and describe your idea. We'll discuss it together and determine the best way to proceed.
We actively welcome your pull requests! Here's how:
- Fork the repository and create your branch:
git checkout -b my-feature-branch - Commit your changes:
git commit -am 'Add some feature' - Push to your forked repository:
git push origin my-feature-branch - Create a pull request to our repository.
Please provide a clear and detailed description of your changes and why you think they should be merged. We appreciate well-documented PRs.
- Use present tense: "Add feature" instead of "Added feature"
- Limit the first line to 72 characters or less
- Reference issue numbers and use keywords (e.g., "Fix #123")
We follow the PEP 8 style guide for Python code. Please ensure your code adheres to these guidelines.
If you're new to our project, you might find it helpful to check out our README file. It contains information about setting up the development environment and running the project locally.
Connect with us on our slack to ask questions, share ideas, and discuss the project.
We appreciate and recognize the contributions of all our contributors. Your time and effort help make this project better for everyone.