Skip to content

Commit 4bafcd8

Browse files
docs: added contrib instrs
1 parent b9d6cde commit 4bafcd8

2 files changed

Lines changed: 365 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ C:.
1111
├── assets
1212
│ └── fonts
1313
│ └── images
14+
├───docs
1415
├── src
1516
│ ├── components
1617
│ ├── data
@@ -24,6 +25,7 @@ C:.
2425
│ │ ├── activities
2526
│ │ │ └── origo
2627
│ │ ├── contact
28+
│ │ ├───hof
2729
│ │ ├── projects
2830
│ │ └── team
2931
│ ├── scripts

docs/CONTRIB-GUIDE.md

Lines changed: 363 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,363 @@
1+
# Guide: How To Use Git And Work On Our Website Project
2+
3+
This is a simple guide I wrote so that anyone joining the project knows exactly how to set things up and contribute without messing things up.
4+
5+
---
6+
7+
# Project File Structure
8+
9+
Below is the structure of the repo. Get familiar with where things go because most issues happen due to wrong paths or wrong placements.
10+
11+
```
12+
C:.
13+
├── assets
14+
│ └── fonts
15+
│ └── images
16+
├───docs
17+
├── src
18+
│ ├── components
19+
│ ├── data
20+
│ │ ├── achievements
21+
│ │ ├── activities
22+
│ │ ├── projects
23+
│ │ └── team
24+
│ ├── pages
25+
│ │ ├── about
26+
│ │ ├── achievements
27+
│ │ ├── activities
28+
│ │ │ └── origo
29+
│ │ ├── contact
30+
│ │ ├── hof
31+
│ │ ├── projects
32+
│ │ └── team
33+
│ ├── scripts
34+
│ └── styles
35+
├── test
36+
└── utils
37+
38+
```
39+
40+
---
41+
42+
# 1. Cloning The Repo
43+
44+
Make sure Git is installed. Then open your terminal and run:
45+
46+
```
47+
48+
git clone [https://github.com/rignitc/RIGNITC](https://github.com/rignitc/RIGNITC)
49+
50+
```
51+
52+
Enter the directory:
53+
54+
```
55+
56+
cd RIGNITC
57+
58+
```
59+
60+
Open it in VS Code:
61+
62+
```
63+
64+
code .
65+
66+
```
67+
68+
## Forking Instead Of Direct Clone
69+
70+
If you want to fork it first, use this link:
71+
72+
**https://github.com/rignitc/RIGNITC/fork**
73+
74+
After forking:
75+
76+
```
77+
78+
git clone <your-fork-link>
79+
cd RIGNITC
80+
code .
81+
82+
```
83+
84+
---
85+
86+
# 2. Setting Up And Running The Project Locally
87+
88+
Open the terminal in VS Code or your usual terminal inside the repo folder.
89+
90+
## Method 1: Build And Serve
91+
92+
Install dependencies (only once):
93+
94+
```
95+
96+
npm install
97+
98+
```
99+
100+
Build the project whenever you make changes:
101+
102+
```
103+
104+
npm run build
105+
106+
```
107+
108+
After build is done:
109+
110+
```
111+
112+
cd dist
113+
python -m http.server 8000
114+
115+
```
116+
117+
Then open:
118+
119+
```
120+
121+
[http://localhost:8000](http://localhost:8000)
122+
123+
```
124+
125+
This shows the actual production build.
126+
127+
## Method 2: Live Server (Quick Testing)
128+
129+
Install the Live Server extension in VS Code.
130+
Right click `index.html` in the left sidebar and select **Open with Live Server**.
131+
132+
Note: Navigation links will not work normally. You must manually append `/src/pages` in the URL because pages live inside `src/pages` but Live Server serves the root.
133+
134+
Example:
135+
136+
Instead of
137+
`http://127.0.0.1:5500/team/`
138+
use
139+
`http://127.0.0.1:5500/src/pages/team/`
140+
141+
### Why this happens
142+
143+
The real deployment uses a GitHub Action that builds the site and deploys from the `dist` folder.
144+
Local Live Server does not know any of that, so you must help it by adjusting links manually.
145+
146+
---
147+
148+
# 3. Making Changes
149+
150+
## Adding Photos
151+
152+
Rules:
153+
154+
1. Use `.webp` format.
155+
2. Place images in the correct folder under `assets/images/...`
156+
3. If the page uses a json file (team, activities, projects, achievements etc), update the path inside the json.
157+
158+
Example: Adding something to `src/data/achievements/competitions.json`
159+
160+
```
161+
162+
{
163+
"title": "ISRO Robotics Challenge (IRoCU 2025)",
164+
"description": "Made it to the qualification round and secured a place among the top 24 teams across India.",
165+
"photo": "assets/images/achievements/competitions/ISRO.webp"
166+
}
167+
168+
```
169+
170+
Place the image here:
171+
172+
```
173+
174+
assets/images/achievements/competitions/
175+
176+
```
177+
178+
### Important Note
179+
Json files are rendered exactly in the order entries appear, so place your new entry where it belongs.
180+
181+
---
182+
183+
## If You Cannot Find A Photo
184+
185+
Use placeholders but **never leave the name empty**.
186+
187+
Example placeholder entry:
188+
189+
```
190+
191+
{
192+
"name": "ASWIN PK",
193+
"photo": "assets/images/team/b12/logo.webp",
194+
"role": "Team Member",
195+
"socials": [
196+
{
197+
"platform": "linkedin",
198+
"url": ""
199+
}
200+
]
201+
}
202+
203+
```
204+
205+
---
206+
207+
## Changing Layout Or Logic
208+
209+
CSS and JS are inside:
210+
211+
```
212+
213+
src/styles/
214+
src/scripts/
215+
216+
```
217+
218+
If you need to find which file controls what, open the page you want:
219+
220+
```
221+
222+
src/pages/<page>/index.html
223+
224+
```
225+
226+
Check the referenced script and style tags, follow their paths.
227+
228+
### Components Check
229+
Before adding new scripts or HTML blocks, make sure they are not already available as a component under:
230+
231+
```
232+
233+
src/components/
234+
235+
```
236+
237+
If you make a new reusable thing like a footer or navbar, keep it parametrizable and reusable.
238+
239+
---
240+
241+
## If Changes Are Not Showing
242+
243+
Open browser dev tools:
244+
245+
```
246+
247+
Ctrl Shift I
248+
249+
```
250+
251+
Hover over the element. You will see which file controls it. Fix that file.
252+
253+
---
254+
255+
# 4. Contribution Rules
256+
257+
These are strict:
258+
259+
- Work must be professional. If not, it will be rejected.
260+
- Never push directly to `main`. The rules prevent it anyway.
261+
- No unnecessary changes or random experiments.
262+
- Always update json entries properly and check output on local build.
263+
- Maintain clean commit structure and make PRs.
264+
265+
---
266+
267+
# 5. Using Git To Commit And Push Changes
268+
269+
Stage files:
270+
271+
```
272+
273+
git add <path>
274+
275+
```
276+
277+
To stage everything:
278+
279+
```
280+
281+
git add .
282+
283+
```
284+
285+
Check what is staged:
286+
287+
```
288+
289+
git status
290+
291+
```
292+
293+
Commit:
294+
295+
```
296+
297+
git commit -m "feat: added new achievement entry"
298+
299+
```
300+
301+
### Commit Message Structure
302+
303+
Use prefixes like:
304+
305+
- `feat:` for new feature or new entry
306+
- `fix:` for correcting something broken
307+
- `chore:` for non feature changes like formatting or moving files
308+
- `refactor:` for improving code logic
309+
- `style:` for css only changes
310+
- `docs:` for documentation updates
311+
312+
Describe exactly what you did.
313+
If you changed many things, write a descriptive message.
314+
315+
Push your branch:
316+
317+
```
318+
319+
git push origin <branch-name>
320+
321+
```
322+
323+
---
324+
325+
# 6. Making A Pull Request Using Commands
326+
327+
Create a new branch first:
328+
329+
```
330+
331+
git checkout -b my-branch
332+
333+
```
334+
335+
After committing and pushing:
336+
337+
```
338+
339+
git push origin my-branch
340+
341+
```
342+
343+
Then open GitHub and it will show **Compare and Pull Request**.
344+
345+
Submit the PR and ask a maintainer to review it.
346+
347+
---
348+
349+
# Final Notes
350+
351+
This is our website and our club. Keep everything clean and well documented.
352+
People maintaining this later should have an easy time understanding what you did.
353+
354+
If you need details about deployment or component usage, read the files in:
355+
356+
```
357+
358+
docs/
359+
360+
```
361+
362+
Be responsible and maintain quality.
363+
Do contact [@SlyPredator](https://github.com/SlyPredator) and [@Mummanajagadeesh](https://github.com/Mummanajagadeesh) if you feel anything is not understood or unclear.

0 commit comments

Comments
 (0)