Skip to content

Commit 0fc3ef8

Browse files
committed
added contributerGuide
1 parent cdbb436 commit 0fc3ef8

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

contributerGuidelines.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
**Contributing to Recodehive🧑‍💻**
2+
3+
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.
4+
5+
**Guidelines for Contributors💡**
6+
7+
1. **Familiarize yourself with the project**: Before contributing, take some time to understand our project's goals, structure, and existing codebase.
8+
9+
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.
10+
11+
3. **Fork and clone the repo**: Fork the Recodehive repository and clone it to your local machine.
12+
13+
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).
14+
15+
5. **Make your changes**: Implement your changes, following our coding standards and best practices.
16+
17+
6. **Test your changes**: Ensure your changes don't break existing functionality and include tests if applicable.
18+
19+
7. **Submit a pull request**: Push your changes and submit a pull request to our main repository.
20+
21+
8. **Engage with the community**: Participate in discussions, respond to feedback, and be open to suggestions and improvements.
22+
23+
**Coding Standards🌐**
24+
25+
- Follow PEP 8 guidelines for Python code
26+
- Use consistent naming conventions and formatting
27+
- Include docstrings and comments for clarity
28+
- Keep commits small and focused
29+
30+
**Best Practices🧠**
31+
32+
- Write clean, modular, and reusable code
33+
- Use version control effectively (e.g., commit messages, branching)
34+
- Test your code thoroughly
35+
- Respect existing code and architectural decisions
36+
37+
**Getting Help**
38+
39+
- Ask questions on our [issues page](https://github.com/recodehive/machine-learning-repos/issues)
40+
- Reach out to the maintainers directly (https://github.com/sanjay-kv)
41+
42+
**Maintainers**
43+
44+
- [Sanjay Viswanathan](https://github.com/sanjay-kv) - Lead Maintainer
45+
46+
47+
**License**
48+
49+
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).
50+
51+
Thank you again for your interest in contributing to Recodehive! We look forward to reviewing your pull requests and collaborating with you.

0 commit comments

Comments
 (0)