Skip to content

Commit bcf2b37

Browse files
authored
Create CONTRIBUTING.md
1 parent a9a02d1 commit bcf2b37

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

CONTRIBUTING.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# 🤝 Contributing to CodeHarborHub Coding Platform
2+
3+
Welcome! 🎉 We’re thrilled that you’d like to contribute to this open-source coding platform. Whether you're fixing bugs, adding new features, or improving documentation — you're helping thousands of developers grow!
4+
5+
---
6+
7+
## 📦 Local Setup
8+
9+
1. **Fork the repo** and clone your fork:
10+
```bash
11+
git clone https://github.com/YOUR_USERNAME/ccoding-platform.git
12+
cd coding-platform
13+
```
14+
15+
2. **Install dependencies**:
16+
17+
```bash
18+
npm install
19+
```
20+
21+
3. **Start development server**:
22+
23+
```bash
24+
npm run dev
25+
```
26+
27+
---
28+
29+
## 🛠️ How to Contribute
30+
31+
### ✅ Bug Fixes / Feature Requests
32+
33+
* Open an [issue](https://github.com/codeharborhub/coding-platform/issues/new) first
34+
* Use good commit messages (`feat`, `fix`, `chore`, ...)
35+
* Follow our coding style and naming conventions
36+
37+
### ✅ Pull Request Process
38+
39+
1. Create a new branch:
40+
41+
```bash
42+
git checkout -b fix/your-feature-name
43+
```
44+
45+
2. Make your changes. Test thoroughly.
46+
47+
3. Commit your changes:
48+
49+
```bash
50+
git commit -m "fix: fixed hint dropdown overflow issue"
51+
```
52+
53+
4. Push and submit PR:
54+
55+
```bash
56+
git push origin fix/your-feature-name
57+
```
58+
59+
5. Submit a [Pull Request](https://github.com/codeharborhub/coding-platform/pulls) and link the issue.
60+
61+
---
62+
63+
## 🌐 Code Style
64+
65+
* Use **React functional components**
66+
* Follow **ESLint rules**
67+
* Use **Tailwind CSS** for styling
68+
* Use **PascalCase** for components, **camelCase** for variables
69+
70+
---
71+
72+
## 🤖 Project Structure
73+
74+
```
75+
src/
76+
┣ components/ # Reusable UI components
77+
┣ pages/ # Route-based pages
78+
┣ data/ # Problem metadata
79+
┣ utils/ # Helper functions
80+
┣ assets/ # Images/icons
81+
```
82+
83+
---
84+
85+
## 💡 Suggestions
86+
87+
Have a cool idea? We’re listening!
88+
Start a [discussion](https://github.com/codeharborhub/coding-platform/discussions) or open an issue.
89+
90+
---
91+
92+
## 🧑‍💻 Contributor Credits
93+
94+
Your name will be listed in the [Contributors tab](https://github.com/codeharborhub/coding-platform/graphs/contributors) when your PR is merged. Thank you! 🙌
95+
96+
---
97+
98+
Built with ❤️ by [Ajay Dhangar](https://github.com/ajay-dhangar)

0 commit comments

Comments
 (0)