Thank you for your interest in contributing to this project! To help us manage contributions efficiently, please follow these guidelines:
- Follow the Style Guide: Ensure your code is consistent with the coding style used in this project. Adhere to naming conventions and formatting standards.
- Write Clean Code: Code should be easy to read and understand. Use meaningful variable names and include comments where necessary to explain complex logic.
- Keep It Simple: Refactor complex code into small, manageable functions that each perform a single task.
- Write Tests: Every new feature should include tests that verify its functionality. We encourage you to write unit tests and integration tests as appropriate.
- Run Tests Before Submission: Ensure all tests are passing before submitting your changes. Use the test suite provided to verify your code.
- Create a Pull Request: Once you have made your changes, submit a pull request describing the changes you've made and why. Include relevant information that can help reviewers understand your contribution.
- Link Related Issues: If your pull request addresses or relates to an existing issue, please reference it in the pull request description (e.g., "Closes #issue-number").
- Respond to Feedback: Be prepared to make changes based on feedback from reviewers. A collaborative approach helps improve the quality of the code.
Your contributions are invaluable to the success of this project. Thank you for being a part of our community!