Skip to content

Commit 460a3c1

Browse files
authored
Merge pull request #67 from shubhranshu-sahu/master
Added Contributing.md
2 parents 74d977e + 90b6ed4 commit 460a3c1

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

Contributing.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Contributing Guidelines
2+
3+
Thank you for considering contributing to **CodeCanvas**! ✨
4+
We welcome contributions that help improve features, fix bugs, add documentation, or enhance the user experience.
5+
6+
---
7+
8+
## 🛠 How to Contribute
9+
10+
### 1. Fork the repository
11+
Click the **Fork** button on the top-right of the repository page on GitHub.
12+
13+
### 2. Clone your fork
14+
Clone your forked repository to your local machine:
15+
16+
```bash
17+
git clone https://github.com/<your-username>/CodeCanvas.git
18+
cd CodeCanvas
19+
```
20+
21+
### 3. Add the upstream (only once)
22+
To stay up to date with the original repository:
23+
24+
```bash
25+
git remote add upstream https://github.com/<original-owner>/CodeCanvas.git
26+
```
27+
28+
### 4. Create a new branch
29+
Always create a branch for your changes:
30+
31+
```bash
32+
git checkout -b feature-name
33+
```
34+
35+
### 5. Make your changes
36+
Follow the **code structure** of the project. Test your changes locally by opening `index.html` in your browser.
37+
38+
### 6. Commit your changes
39+
Write a meaningful commit message:
40+
41+
```bash
42+
git add .
43+
git commit -m "Add: description of your changes"
44+
```
45+
46+
### 7. Keep your fork updated
47+
Before pushing, fetch and rebase with upstream:
48+
49+
```bash
50+
git fetch upstream
51+
git rebase upstream/main
52+
```
53+
54+
Resolve any conflicts if prompted.
55+
56+
### 8. Push and open a Pull Request
57+
Push your branch:
58+
59+
```bash
60+
git push origin feature-name
61+
```
62+
63+
Then open a Pull Request from your fork to the main repository.
64+
65+
---
66+
67+
## 💡 Tips for Contributions
68+
69+
- Make small, focused pull requests.
70+
- Write clear commit messages.
71+
- Ensure your code runs without errors locally.
72+
- Update the documentation (README/CONTRIBUTING) if required.
73+
74+
---
75+
76+
## 📜 Code of Conduct
77+
78+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
79+
80+
---
81+
82+
## 🤝 Need Help?
83+
84+
If you face any difficulty while contributing, feel free to open an issue or reach out to the maintainers.
85+
86+
---
87+
88+
Happy Coding! 🎉

0 commit comments

Comments
 (0)