Skip to content

Commit 9661d5a

Browse files
Create CONTRIBUTING.md
1 parent 87c099d commit 9661d5a

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to the Mergington High Extra-Curricular Activities Website
2+
3+
Thank you for your interest in helping improve our school's website!
4+
Whether you want to add your club's activities, fix a bug, or suggest
5+
new features, this guide will help you get started. 🎉
6+
7+
## Development Setup
8+
9+
1. Clone the repository to your computer.
10+
2. Install Python requirements: `pip install -r requirements.txt`.
11+
3. Run the development server: `python src/app.py`.
12+
4. Visit http://localhost:8000 in your browser to see the website.
13+
14+
## Making Changes
15+
16+
1. Create a new branch for your changes.
17+
- Use descriptive names like `art-gallery-feature` or `fix-chess-signup`
18+
2. Make your changes and test them locally with sample student data.
19+
- Use the MongoDB extension to preview the included sample date.
20+
3. Push your branch and create a pull request.
21+
4. Wait for review and address any feedback.
22+
23+
## Code Style
24+
25+
- Follow PEP 8 for Python code (backend).
26+
- Use clear, descriptive variable names (student_name, start_time, etc.)
27+
- Add comments to describe blocks of logic.
28+
29+
## Need help or have ideas?
30+
31+
- Check the open issues first.
32+
- If your problem is there, add a comment or up-vote.
33+
- If not there, create a new issue. Be as descriptive as possible.
34+
- Ask in our weekly IT Club office hours (Thursdays at lunch in Room 203).
35+
- For other general problems, email the tech team at [email protected]

0 commit comments

Comments
 (0)