Skip to content

Commit 7dff9c3

Browse files
Merge pull request Gagandeep-2003#54 from debug-soham/docs/improve-contributing-guide
Docs: Improve Formatting of CONTRIBUTING.md
2 parents 4b86426 + 05f34cc commit 7dff9c3

File tree

1 file changed

+67
-54
lines changed

1 file changed

+67
-54
lines changed

CONTRIBUTING.md

Lines changed: 67 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,81 @@
11
# Contributing to Driver Drowsiness Detection System 🚗💤
22

3-
Thanks for your interest in contributing! This guide will help you get started.
3+
First off, thank you for considering contributing to this project! Your help is greatly appreciated.
44

5-
🙏 **If you haven't already, please consider [starring the repository](https://github.com/Gagandeep-2003/Driver-Drowsiness-Detection-System)** to show your support and help others discover the project.
5+
🙏 **If you haven't already, please consider starring the [repository](https://github.com/Gagandeep-2003/Driver-Drowsiness-Detection-System)to show your support and help others discover the project.**
66

77
---
88

99
## 🛠️ Project Setup
10-
11-
1. **Fork the repository**
12-
Click the `Fork` button on the top right of the repo.
13-
14-
2. **Clone your fork**
15-
```bash
16-
git clone https://github.com/Gagandeep-2003/driver-drowsiness-detection-system.git
17-
cd driver-drowsiness-detection-system
18-
19-
Create a virtual environment (optional but recommended)
20-
21-
python -m venv venv
22-
source venv/bin/activate # or venv\Scripts\activate on Windows
23-
24-
Install dependencies
25-
10+
Follow these steps to get the project running on your local machine.
11+
### 1. **Fork and Clone**
12+
1. **Fork the repository**: Click the `Fork` button on the top right of the repo.
13+
2. **Clone your fork**:
14+
15+
```bash
16+
git clone https://github.com/YOUR-USERNAME/driver-drowsiness-detection-system.git
17+
cd driver-drowsiness-detection-system
18+
```
19+
20+
### 2. **Set Up Your Environment**
21+
1. **Create a virtual environment** (optional but highly recommended):
22+
23+
```bash
24+
# On Windows
25+
py -m venv venv
26+
venv\Scripts\activate
27+
28+
# On macOS/Linux
29+
python3 -m venv venv
30+
source venv/bin/activate
31+
```
32+
33+
2. **Install dependencies**:
34+
35+
```bash
2636
pip install -r requirements.txt
37+
```
38+
39+
3. **Download the dlib model**: The blink detection feature requires a pre-trained model.
40+
* Download the file from [this link](https://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2).
41+
* Unzip it and place the `shape_predictor_68_face_landmarks.dat` file inside the `/models` directory.
42+
43+
<br>
44+
45+
## 🔄 How to Contribute
46+
47+
1. **Find an issue**: Check the existing [issues](https://github.com/Gagandeep-2003/Driver-Drowsiness-Detection-System/issues) to see if you can help, or raise a new issue if you have a new idea.
48+
2. **Create a new branch**:
49+
50+
```bash
51+
git checkout -b your-feature-name
52+
```
53+
54+
3. **Make your changes**: Write your code and make sure to follow the project's style.
55+
4. **Commit your changes**:
56+
57+
```bash
58+
git add .
59+
git commit -m "feat: Add feature XYZ"
60+
```
61+
62+
5. **Push and create a pull request (PR)**:
63+
64+
```bash
65+
git push origin your-feature-name
66+
```
67+
68+
Then, go to your fork on GitHub and click "Compare & pull request".
2769
28-
🔄 How to Contribute
29-
30-
Check existing issues or ask to be assigned one on Discord.
31-
32-
Create a new branch
33-
34-
git checkout -b feature-name
35-
36-
Make your changes
37-
38-
Commit your changes
39-
40-
git add .
41-
git commit -m "Added feature XYZ"
42-
43-
Push and create a pull request (PR)
44-
45-
git push origin feature-name
46-
47-
Then go to your fork on GitHub and click "Compare & pull request".
48-
49-
✅ Guidelines
50-
51-
Keep your code clean and readable
52-
53-
Follow existing naming and code style
54-
55-
Comment your code where needed
70+
---
5671
57-
One feature or bug fix per PR
72+
## ✅ Contribution Guidelines
73+
* Keep your code clean, readable, and well-commented where necessary.
74+
* Follow the existing naming conventions and code style.
75+
* Ensure each pull request addresses only one feature or bug fix.
5876
59-
🙌 Need Help?
77+
## 🙌 Need Help?
6078
6179
Feel free to ask questions in the GSSoC Discord or open a discussion!
6280
63-
Let’s build something amazing together 🚀
64-
65-
66-
---
67-
68-
Let me know if you want to add sections like testing instructions or folder structure too!
81+
> Let’s build something amazing together 🚀

0 commit comments

Comments
 (0)