Skip to content

Commit dc18a02

Browse files
NotHarshhaaNotHarshhaa
committed
IntoTheDevOps: CONTRIBUTING: Revamp contribution guidelines
- Added detailed sections on getting started, content requirements, quality standards. - Added submission process for improved clarity and usability. Signed-off-by: NotHarshhaa <reddyharshhaa12@gmail.com>
1 parent 0d71828 commit dc18a02

File tree

1 file changed

+177
-14
lines changed

1 file changed

+177
-14
lines changed

‎CONTRIBUTING.md‎

Lines changed: 177 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,186 @@
1-
## How to contribute
1+
# 🤝 Contributing to Into The DevOps
22

3-
Use pull requests to contribute to the project.
3+
Thank you for your interest in contributing to Into The DevOps! This document provides guidelines and instructions for contributing to the project.
44

5-
Stick to the following format:
5+
## 📋 Table of Contents
66

7-
\<details>
8-
<summary>[Question]</summary><br><b>
7+
1. [Getting Started](#getting-started)
8+
2. [Contribution Guidelines](#contribution-guidelines)
9+
3. [Content Format](#content-format)
10+
4. [Quality Standards](#quality-standards)
11+
5. [Submission Process](#submission-process)
12+
6. [Additional Resources](#additional-resources)
913

10-
[Answer]
11-
\</b></details>
14+
## 🚀 Getting Started
1215

13-
* If you added several questions and you would like to know how many questions are there you can use the script "count_questions.sh" in scripts directory.
16+
1. **Fork the Repository**
17+
- Click the 'Fork' button at the top right of this repository
18+
- Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/into-the-devops.git`
1419

15-
## What to avoid
20+
2. **Create a Branch**
21+
- Create a new branch for your contribution:
22+
```bash
23+
git checkout -b feature/your-contribution-name
24+
```
1625

17-
* Avoid adding installation questions. Those are the worst type of questions...
18-
* Don't copy questions and answers from other sources. They probably worked hard for adding them.
19-
* If you add new images, make sure they are free and can be used.
26+
3. **Set Up Development Environment**
27+
- Ensure you have Python installed for running validation scripts
28+
- Install any necessary dependencies (if applicable)
2029

21-
## Before submitting the pull request
30+
## 📝 Contribution Guidelines
2231

23-
You can test your changes locally with the script `run_ci.sh` script.
32+
### What We Accept
33+
34+
✅ **Do Contribute**:
35+
- High-quality DevOps interview questions and answers
36+
- Real-world scenarios and examples
37+
- Best practices and common pitfalls
38+
- Clear, concise explanations
39+
- Practical exercises and solutions
40+
- Updated or improved documentation
41+
42+
❌ **Don't Contribute**:
43+
- Installation instructions or basic setup questions
44+
- Content copied from other sources without permission
45+
- Low-quality or unclear questions/answers
46+
- Outdated technology references
47+
- Non-free or copyrighted images
48+
49+
### Content Requirements
50+
51+
1. **Originality**
52+
- All content must be original or properly licensed
53+
- Give credit where due
54+
- Respect intellectual property rights
55+
56+
2. **Quality**
57+
- Content should be clear and well-explained
58+
- Include practical examples where possible
59+
- Ensure technical accuracy
60+
- Keep content up-to-date with current practices
61+
62+
3. **Relevance**
63+
- Content should be relevant to DevOps practices
64+
- Focus on practical, real-world scenarios
65+
- Target intermediate to advanced topics
66+
67+
## 📌 Content Format
68+
69+
### Question Format
70+
71+
Use the following format for adding questions:
72+
73+
```markdown
74+
<details>
75+
<summary>Your Question Here</summary><br><b>
76+
77+
Your detailed answer here. Make sure to:
78+
- Use proper formatting
79+
- Include code examples if applicable
80+
- Add relevant diagrams or images if needed
81+
- Provide references when necessary
82+
83+
</b></details>
84+
```
85+
86+
### Formatting Guidelines
87+
88+
1. **Questions**
89+
- Should be clear and specific
90+
- Use proper grammar and punctuation
91+
- Avoid yes/no questions
92+
- Focus on practical scenarios
93+
94+
2. **Answers**
95+
- Provide comprehensive explanations
96+
- Include code examples when relevant
97+
- Use proper markdown formatting
98+
- Add diagrams or images if helpful
99+
100+
3. **Images**
101+
- Use only free-to-use images
102+
- Optimize images for web viewing
103+
- Include alt text for accessibility
104+
- Store in the appropriate images directory
105+
106+
## 🎯 Quality Standards
107+
108+
### Content Quality
109+
110+
1. **Technical Accuracy**
111+
- Ensure all technical information is correct
112+
- Verify code examples work
113+
- Test commands and procedures
114+
- Keep content up-to-date
115+
116+
2. **Writing Quality**
117+
- Use clear, professional language
118+
- Check grammar and spelling
119+
- Maintain consistent formatting
120+
- Follow markdown best practices
121+
122+
### Validation
123+
124+
1. **Local Testing**
125+
- Run the validation script before submitting:
126+
```bash
127+
./run_ci.sh
128+
```
129+
- Fix any reported issues
130+
- Test all code examples
131+
132+
2. **Question Count**
133+
- Use the provided script to count questions:
134+
```bash
135+
./scripts/count_questions.sh
136+
```
137+
138+
## 📤 Submission Process
139+
140+
1. **Before Submitting**
141+
- Run all validation scripts
142+
- Review your changes
143+
- Update documentation if needed
144+
- Test on your local environment
145+
146+
2. **Creating Pull Request**
147+
- Push your changes to your fork
148+
- Create a pull request from your branch
149+
- Fill out the PR template completely
150+
- Link any related issues
151+
152+
3. **PR Description**
153+
- Clearly describe your changes
154+
- Explain the motivation
155+
- List any dependencies
156+
- Mention related issues
157+
158+
## 🔍 Review Process
159+
160+
1. **Initial Check**
161+
- Automated tests will run
162+
- Basic formatting will be verified
163+
- Content guidelines will be checked
164+
165+
2. **Manual Review**
166+
- A maintainer will review your PR
167+
- Feedback may be provided
168+
- Changes may be requested
169+
- Discussions may occur in PR comments
170+
171+
## 📚 Additional Resources
172+
173+
- [Markdown Guide](https://www.markdownguide.org/)
174+
- [DevOps Best Practices](https://github.com/NotHarshhaa/into-the-devops)
175+
- [Git Workflow Guide](https://guides.github.com/introduction/flow/)
176+
177+
## ❓ Questions or Problems?
178+
179+
If you have questions or run into problems:
180+
- Open an issue in the repository
181+
- Ask in the PR comments
182+
- Join our [community chat](https://t.me/prodevopsguy)
183+
184+
---
185+
186+
Thank you for contributing to Into The DevOps! Your efforts help make this resource better for everyone in the DevOps community. 🙏

0 commit comments

Comments
 (0)