diff --git a/contributerGuidelines.md b/contributerGuidelines.md new file mode 100644 index 000000000..151d19f9d --- /dev/null +++ b/contributerGuidelines.md @@ -0,0 +1,51 @@ +**Contributing to Recodehive🧑‍💻** + +Thank you for your interest in contributing to **Recodehive**, and specially for machine learning repository! We appreciate your willingness to help us improve and expand our project. + +**Guidelines for Contributors💡** + +1. **Familiarize yourself with the project**: Before contributing, take some time to understand our project's goals, structure, and existing codebase. + +2. **Check the issues page**: Look for open issues and tasks on our [issues page](https://github.com/recodehive/machine-learning-repos/issues). This will help you identify areas where we need help. + +3. **Fork and clone the repo**: Fork the Recodehive repository and clone it to your local machine. + +4. **Create a new branch**: Create a new branch for your contribution, using a descriptive name (e.g., fix-issue-123 or add-new-feature). + +5. **Make your changes**: Implement your changes, following our coding standards and best practices. + +6. **Test your changes**: Ensure your changes don't break existing functionality and include tests if applicable. + +7. **Submit a pull request**: Push your changes and submit a pull request to our main repository. + +8. **Engage with the community**: Participate in discussions, respond to feedback, and be open to suggestions and improvements. + +**Coding Standards🌐** + +- Follow PEP 8 guidelines for Python code +- Use consistent naming conventions and formatting +- Include docstrings and comments for clarity +- Keep commits small and focused + +**Best Practices🧠** + +- Write clean, modular, and reusable code +- Use version control effectively (e.g., commit messages, branching) +- Test your code thoroughly +- Respect existing code and architectural decisions + +**Getting Help** + +- Ask questions on our [issues page](https://github.com/recodehive/machine-learning-repos/issues) +- Reach out to the maintainers directly (https://github.com/sanjay-kv) + +**Maintainers** + +- [Sanjay Viswanathan](https://github.com/sanjay-kv) - Lead Maintainer + + +**License** + +By contributing to Recodehive, you agree to release your contributions under the [project's license](https://github.com/recodehive/machine-learning-repos?tab=MIT-1-ov-file#readme). + +Thank you again for your interest in contributing to Recodehive! We look forward to reviewing your pull requests and collaborating with you. \ No newline at end of file