Skip to content

Commit 75132b7

Browse files
Add contributing guidelines for the project
Added a detailed contributing guide for the Student Management System, outlining steps for forking, cloning, branching, setting up the project, making changes, committing, pushing, and raising pull requests.
1 parent addffd0 commit 75132b7

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributing to Student Management System
2+
3+
Thank you for your interest in contributing! Please follow the steps below carefully.
4+
5+
---
6+
7+
## Step 1: Fork the Repository
8+
9+
Click the Fork button on the top right of this page.
10+
This creates a copy of the repo in your GitHub account.
11+
12+
---
13+
14+
## Step 2: Clone Your Fork
15+
16+
git clone https://github.com/YOUR_USERNAME/student-management.git
17+
cd student-management
18+
19+
---
20+
21+
## Step 3: Create a New Branch
22+
23+
Never commit directly to main. Always create a new branch.
24+
25+
git checkout -b feature/your-feature-name
26+
27+
Branch naming rules:
28+
- New feature → feature/your-feature-name
29+
- Bug fix → fix/your-bug-name
30+
- Documentation → docs/your-doc-name
31+
32+
---
33+
34+
## Step 4: Setup the Project Locally
35+
36+
1. Start MySQL and create database:
37+
CREATE DATABASE IF NOT EXISTS studentdb;
38+
39+
2. Create src/main/resources/application.properties:
40+
server.port=8082
41+
spring.datasource.url=jdbc:mysql://localhost:3306/studentdb
42+
spring.datasource.username=root
43+
spring.datasource.password=your_password
44+
spring.jpa.hibernate.ddl-auto=update
45+
46+
3. Create .env file in root:
47+
ADMIN_USERNAME=your_username
48+
ADMIN_PASSWORD=your_password
49+
DB_URL=jdbc:mysql://localhost:3306/studentdb
50+
DB_USERNAME=root
51+
DB_PASSWORD=your_password
52+
PORT=8082
53+
54+
4. Run the project:
55+
mvn spring-boot:run
56+
57+
5. Open browser:
58+
http://localhost:8082
59+
60+
---
61+
62+
## Step 5: Make Your Changes
63+
64+
- Follow standard Java naming conventions
65+
- Add comments where necessary
66+
- Keep methods small and focused
67+
- Do not push application.properties or .env files
68+
69+
---
70+
71+
## Step 6: Commit Your Changes
72+
73+
git add .
74+
git commit -m "Add: brief description of your change"
75+
76+
---
77+
78+
## Step 7: Push Your Branch
79+
80+
git push origin feature/your-feature-name
81+
82+
---
83+
84+
## Step 8: Raise a Pull Request
85+
86+
1. Go to the original repo on GitHub
87+
2. Click New Pull Request
88+
3. Select your branch
89+
4. Fill in the PR description properly
90+
91+
---
92+
93+
## PR Description Rules (Very Important!)
94+
95+
Your PR will be automatically checked by Prashant's PR Checker Bot.
96+
The bot will reject your PR if:
97+
98+
- You have not linked an issue
99+
- Your description is too short
100+
101+
Always write like this in your PR description:
102+
103+
Fixes #ISSUE_NUMBER
104+
105+
Brief description of what you changed and why.
106+
107+
Example:
108+
109+
Fixes #2
110+
111+
Added search functionality to filter students by course name.
112+
The search bar on dashboard now filters results in real time without page reload.
113+
114+
---
115+
116+
## Step 9: Wait for Review
117+
118+
Once your PR passes the bot check it will get the ready-for-review label.
119+
Then wait for Prashant to review and merge your PR.
120+
121+
---
122+
123+
## Need Help?
124+
125+
Open a new issue and describe your problem clearly.
126+
Label it as question or help wanted.

0 commit comments

Comments
 (0)