Skip to content

Commit 05605e4

Browse files
Merge pull request #4 from eksandy/patch-1
Update CONTRIBUTING.md
2 parents bedc1bb + 2b8d68e commit 05605e4

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# **Contributing to Dev-Blogs**
2+
3+
Welcome, and thank you for considering contributing to **Dev-Blogs**! 🙌 We're excited to have you collaborate with us to build and improve this open-source project. Below are the guidelines to help you get started.
4+
5+
---
6+
7+
## **How Can You Contribute?**
8+
9+
We welcome contributions of all kinds, including but not limited to:
10+
11+
- **Adding Blog Posts**: Submit a technical blog post related to development, technology, or open-source.
12+
- **Fixing Bugs**: Find and fix bugs or issues within the project.
13+
- **Suggesting New Features**: Have a new feature in mind? Propose it or help implement it.
14+
- **Improving Documentation**: Help us maintain up-to-date and accurate documentation.
15+
16+
---
17+
18+
## **Step-by-Step Guide to Contributing**
19+
20+
### **1. Fork the Repository**
21+
To make contributions, you'll first need to fork the repository:
22+
1. Navigate to the [Dev-Blogs repository](#).
23+
2. Click the **Fork** button at the top-right corner to create a copy of the repository under your GitHub account.
24+
25+
### **2. Clone Your Fork**
26+
Once you've forked the repository, clone it to your local machine using the following command:
27+
```bash
28+
git clone https://github.com/ekrishnachaitanya2004/Dev-Blogs
29+
```
30+
This will create a local copy of the project on your machine.
31+
32+
### **3. Create a New Branch**
33+
Always work on a separate branch for your changes:
34+
```bash
35+
git checkout -b my-feature-branch
36+
```
37+
Name your branch appropriately based on the changes you're making, e.g., `add-blog-post`, `fix-bug`, `improve-docs`.
38+
39+
### **4. Make Changes**
40+
- **For Blog Posts**:
41+
- Add your blog in the appropriate directory (e.g., `/content/blogs/`).
42+
- Blog posts should follow our markdown structure and guidelines outlined in the **[Blogging Guidelines](#)**.
43+
- Include images or links if needed and ensure your blog post is formatted correctly.
44+
45+
- **For Code Contributions**:
46+
- Make sure you follow the project’s coding standards.
47+
- Ensure your changes are functional and, if possible, write tests to accompany your code.
48+
49+
### **5. Test Your Changes**
50+
Before submitting, test your changes locally to ensure they work as expected. For blog posts, you can preview the website:
51+
```bash
52+
npm install
53+
npm run dev
54+
```
55+
This will start the local development server.
56+
57+
### **6. Commit Your Changes**
58+
After verifying your changes, stage the modified files and commit them:
59+
```bash
60+
git add .
61+
git commit -m "Add: Description of changes"
62+
```
63+
- Use concise and descriptive commit messages (e.g., `Fix: Bug in navigation menu` or `Add: New blog post on JavaScript basics`).
64+
65+
### **7. Push Your Changes**
66+
Push your changes to your forked repository on GitHub:
67+
```bash
68+
git push origin my-feature-branch
69+
```
70+
71+
### **8. Submit a Pull Request (PR)**
72+
Once your changes are pushed, go to the original **Dev-Blogs** repository and submit a pull request (PR):
73+
1. Go to the **Pull Requests** tab.
74+
2. Click **New Pull Request**.
75+
3. Choose the branch with your changes and submit the PR.
76+
4. In the PR description, clearly explain the changes you’ve made and why they are beneficial.
77+
78+
Your pull request will then be reviewed by maintainers, and feedback may be provided.
79+
80+
---

0 commit comments

Comments
 (0)