Contribution Guidelines
Thank you for your interest in contributing to this project! Please follow the rules outlined below to ensure a smooth collaboration.
1. Contribution Criteria
- Meaningful Contributions: Ensure your contributions add value to the project, including new features, bug fixes, or documentation improvements.
- No Spam PRs: Avoid submitting pull requests that don't have a clear purpose or are unrelated to the project.
2. Code Quality
- Follow Coding Standards: Adhere to the coding style and conventions used in the project for consistency.
- Comment Your Code: Provide clear comments to explain complex logic or functionality.
3. Documentation
- Update Documentation: If your changes affect the project, update the relevant documentation (e.g.,
README.md
).
- Clear Commit Messages: Use descriptive commit messages following this format:
Where
Type
can be Feature
, Fix
, Docs
, etc.
4. Pull Request Process
- Use Feature Branches: Create a new branch for your feature or bug fix.
- Open a Pull Request: Once ready, open a pull request against the main branch.
- Respect Code Review: Be open to feedback and address comments made by project maintainers.
5. Communication
- Be Respectful: Maintain a respectful tone in all communications. Engage constructively in discussions and code reviews.
- Ask Questions: If you’re unsure about something, feel free to ask for clarification.
6. License and Ownership
- Respect Licensing: By contributing, you agree that your contributions are made under the project's license.
- Original Work: Ensure your contributions are original and do not contain copyrighted materials without permission.
7. Hacktoberfest Specifics
- Timely Submissions: Submit your PRs during the Hacktoberfest event (October 1-31) to be eligible for Hacktoberfest rewards.
- Contribution Limits: Be mindful of the contribution limits set by Hacktoberfest; ensure your PRs comply with their guidelines.
8. Enjoy the Process!
- Have Fun: Hacktoberfest is a great opportunity to learn and collaborate. Enjoy the experience!
Thank you for contributing!