Skip to content

Commit 06499a0

Browse files
committed
Enhance CONTRIBUTING.md with detailed contribution guidelines and steps
1 parent 54102dc commit 06499a0

1 file changed

Lines changed: 73 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,73 @@
1-
# Contribute the Project
1+
# Contributing to All-in-Dev
2+
3+
Thank you for considering contributing to the **All-in-Dev Open Source Project**! Contributions help make this repository a valuable resource for developers worldwide. Whether you're fixing a typo, adding a new tool, or creating a whole new category, your help is appreciated.
4+
5+
---
6+
7+
## How to Contribute
8+
9+
### 1. Add New Tools or Categories
10+
You can help expand the repository by:
11+
- Adding a new tool to an existing category.
12+
- Creating a new category with relevant tools.
13+
14+
**Steps**:
15+
1. Fork the repository.
16+
2. Navigate to the appropriate section or create a new one.
17+
3. Add the tool with the following format:
18+
```markdown
19+
- **Tool Name**: A brief description of the tool and its main use.
20+
- [Tool Link](https://example.com)
21+
```
22+
4. Submit a pull request with your changes.
23+
24+
### 2. Improve Existing Documentation
25+
You can contribute by improving the descriptions, adding examples, or fixing typos in the existing documentation.
26+
27+
**Steps**:
28+
1. Fork the repository.
29+
2. Edit the relevant files with your improvements.
30+
3. Submit a pull request explaining the changes you've made.
31+
32+
### 3. Submit Bug Reports or Feature Requests
33+
If you encounter an issue or have ideas for new features:
34+
35+
1. Open an issue in the repository.
36+
2. Provide as much detail as possible, including:
37+
- Steps to reproduce bugs.
38+
- Clear descriptions of your feature request.
39+
- Relevant examples or use cases.
40+
41+
---
42+
43+
## Guidelines for Contributions
44+
45+
- **Consistency**: Follow the existing structure and style of the repository.
46+
- **Relevance**: Ensure tools or categories are relevant to the scope of the project.
47+
- **Clarity**: Use clear and concise language in documentation.
48+
- **Licensing**: Only submit tools that comply with open-source licensing.
49+
50+
---
51+
52+
## Submitting a Pull Request
53+
54+
1. Fork the repository and create your branch:
55+
```bash
56+
git checkout -b feature/your-feature-name
57+
```
58+
59+
2. Make your changes and commit them:
60+
```bash
61+
git commit -m "Add: Description of your changes"
62+
```
63+
64+
3. Push your branch to your fork:
65+
```bash
66+
git push origin feature/your-feature-name
67+
```
68+
69+
4. Open a pull request with a clear title and description.
70+
71+
---
72+
73+
Thank you for your contributions! Together, we can make this resource even better for the developer community.

0 commit comments

Comments
 (0)