Skip to content

Commit b024099

Browse files
Create CONTRIBUTION.md
1 parent b59d8bf commit b024099

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

CONTRIBUTION.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing to Driver Drowsiness Detection System 🚗💤
2+
3+
Thanks for your interest in contributing! This guide will help you get started.
4+
5+
---
6+
7+
## 🛠️ Project Setup
8+
9+
1. **Fork the repository**
10+
Click the `Fork` button on the top right of the repo.
11+
12+
2. **Clone your fork**
13+
```bash
14+
git clone https://github.com/Gagandeep-2003/driver-drowsiness-detection-system.git
15+
cd driver-drowsiness-detection-system
16+
17+
Create a virtual environment (optional but recommended)
18+
19+
python -m venv venv
20+
source venv/bin/activate # or venv\Scripts\activate on Windows
21+
22+
Install dependencies
23+
24+
pip install -r requirements.txt
25+
26+
🔄 How to Contribute
27+
28+
Check existing issues or ask to be assigned one on Discord.
29+
30+
Create a new branch
31+
32+
git checkout -b feature-name
33+
34+
Make your changes
35+
36+
Commit your changes
37+
38+
git add .
39+
git commit -m "Added feature XYZ"
40+
41+
Push and create a pull request (PR)
42+
43+
git push origin feature-name
44+
45+
Then go to your fork on GitHub and click "Compare & pull request".
46+
47+
✅ Guidelines
48+
49+
Keep your code clean and readable
50+
51+
Follow existing naming and code style
52+
53+
Comment your code where needed
54+
55+
One feature or bug fix per PR
56+
57+
🙌 Need Help?
58+
59+
Feel free to ask questions in the GSSoC Discord or open a discussion!
60+
61+
Let’s build something amazing together 🚀
62+
63+
64+
---
65+
66+
Let me know if you want to add sections like testing instructions or folder structure too!

0 commit comments

Comments
 (0)