Thank you for considering contributing to this project! To ensure a smooth and efficient process, please follow the guidelines below.
- Open an Issue: If you find a bug or have a new feature suggestion, please open an issue to discuss it.
- Fork and Branch: Fork the project and create a new branch for your contributions. For example:
git checkout -b feature/AmazingFeature
- Commit Messages: Write meaningful and descriptive commit messages. Try to follow this format:
Subject (Type): Brief description - Detailed explanation and list of changes - Create a Pull Request (PR): After committing your changes, create a pull request. In your pull request description, please include:
- The type of change you made (bug fix, new feature, etc.)
- Which issue you are addressing (if applicable)
- How you tested your changes
- Any additional information or notes
- Write Tests: Ensure that you write appropriate tests for any new features or bug fixes.
- Documentation: Ensure your code and any new features are well-documented with comments and documentation.
- Open an Issue and Discuss: Before making changes, open a relevant issue or discuss your ideas on an existing issue. This helps avoid conflicts and duplicate work.
- Small and Meaningful Changes: Submit your changes in small and meaningful increments. Avoid large and complex pull requests.
- Feedback: You may receive feedback on your pull requests. Address any feedback by making necessary adjustments.
- Everyone's contributions are valuable and should be treated with respect.
- Constructive criticism and positive feedback are important.
- Be respectful, polite, and professional in your communication.
By contributing to this project, you agree that your contributions will be licensed under the LICENSE.
If you have any questions or feedback, please feel free to contact us at:
Thank you again for your contributions!