Skip to content

Commit 5971b1a

Browse files
Merge pull request #33 from Vishal002003/add-contributing-guide
Add CONTRIBUTING.md guide
2 parents 602d1ee + 044a3f7 commit 5971b1a

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to [Project Name]
2+
3+
Thank you for considering contributing to this project! 🎉
4+
5+
## How to Contribute
6+
7+
### Reporting Bugs
8+
- Check if the bug has already been reported in Issues
9+
- Use a clear and descriptive title
10+
- Describe the steps to reproduce the issue
11+
- Include screenshots if applicable
12+
13+
### Suggesting Enhancements
14+
- Use a clear and descriptive title
15+
- Provide a detailed description of the proposed feature
16+
- Explain why this enhancement would be useful
17+
18+
### Pull Request Process
19+
20+
1. **Fork the repository**
21+
2. **Create a new branch** from `main`:
22+
- Use descriptive branch names (e.g., `fix-bug-123`, `add-feature-x`)
23+
3. **Make your changes**
24+
- Write clear, concise commit messages
25+
- Follow the existing code style
26+
4. **Test your changes** thoroughly
27+
5. **Submit a pull request**
28+
- Provide a clear description of the changes
29+
- Reference any related issues
30+
31+
### Branch Naming Convention
32+
- `feature/` - for new features
33+
- `fix/` - for bug fixes
34+
- `docs/` - for documentation updates
35+
- `refactor/` - for code refactoring
36+
37+
### Commit Message Guidelines
38+
- Use present tense ("Add feature" not "Added feature")
39+
- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
40+
- Keep the first line under 50 characters
41+
- Reference issues when applicable (#123)
42+
43+
## Code Style
44+
- Follow the existing code style in the project
45+
- Use meaningful variable and function names
46+
- Comment your code when necessary
47+
48+
## Questions?
49+
Feel free to open an issue for any questions or concerns!
50+
51+
## Code of Conduct
52+
Please be respectful and constructive in all interactions.

0 commit comments

Comments
 (0)