danielroe.dev
[READ-ONLY] Mirror of https://github.com/danielroe/skills-introduction-to-repository-management. Exercise: introduction to repository management
chore: initial repo setup (#4)
author
Daniel Roe
committer
GitHub
date
(May 8, 2025, 4:39 PM +0100)
commit
3876dd6c
3876dd6c0c47b491fa434d9b733ae0af0a0b49f7
parent
66895952
668959521b2d55c786cd59d3088c9f94233be112
+163
+11
.github/dependabot.yml
+11
.github/dependabot.yml
···
1
+
# To get started with Dependabot version updates, you'll need to specify which
2
+
# package ecosystems to update and where the package manifests are located.
3
+
# Please see the documentation for all configuration options:
4
+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
+
6
+
version: 2
7
+
updates:
8
+
- package-ecosystem: "pip" # See documentation for possible values
9
+
directory: "/" # Location of package manifests
10
+
schedule:
11
+
interval: "weekly"
+24
.gitignore
+24
.gitignore
···
1
+
# Python backend for club management
2
+
__pycache__/
3
+
*.py[cod] # Python compiled files
4
+
*$py.class
5
+
*.so
6
+
.Python
7
+
env/
8
+
.env # Where database passwords are stored
9
+
venv/ # Virtual environment for testing
10
+
.venv
11
+
12
+
# Teacher IDE settings
13
+
.vscode/ # Ms. Rodriguez uses VS Code
14
+
.idea/ # Mr. Chen uses PyCharm
15
+
16
+
# Local development & testing
17
+
instance/
18
+
.pytest_cache/
19
+
.coverage # Test coverage reports
20
+
htmlcov/
21
+
22
+
# Staff computer files
23
+
.DS_Store # For teachers with Macs
24
+
Thumbs.db # For teachers with Windows
+7
CODEOWNERS
+7
CODEOWNERS
+58
CODE_OF_CONDUCT.md
+58
CODE_OF_CONDUCT.md
···
1
+
# Mergington High School Code of Conduct
2
+
3
+
## Our Pledge
4
+
5
+
In the interest of fostering an open and welcoming environment for
6
+
our school community, we as contributors and maintainers pledge to
7
+
make participation in the Extra-Curricular Activities project a
8
+
respectful and harassment-free experience for everyone.
9
+
10
+
## Our Standards
11
+
12
+
Examples of behavior that contributes to creating a positive environment include:
13
+
14
+
- Using welcoming and inclusive language
15
+
- Being respectful of differing viewpoints and experiences
16
+
- Gracefully accepting constructive criticism
17
+
- Focusing on what is best for the students and the school community
18
+
- Showing empathy towards other community members
19
+
20
+
Examples of unacceptable behavior include:
21
+
22
+
- The use of inappropriate language or imagery
23
+
- Trolling, insulting comments, and personal attacks
24
+
- Public or private harassment
25
+
- Publishing others' private information without explicit permission
26
+
- Other conduct which could reasonably be considered inappropriate in a school setting
27
+
28
+
## Responsibilities
29
+
30
+
Project maintainers are responsible for clarifying the standards of
31
+
acceptable behavior and are expected to take appropriate and fair
32
+
corrective action in response to any instances of unacceptable behavior.
33
+
34
+
Project maintainers have the right and responsibility to remove, edit,
35
+
or reject comments, commits, code, issues, and other contributions that
36
+
are not aligned to this Code of Conduct.
37
+
38
+
## Scope
39
+
40
+
This Code of Conduct applies both within project spaces and in public spaces
41
+
when an individual is representing the project or the school. Examples of
42
+
representing the project include using an official project email address,
43
+
posting via an official social media account, or acting as an appointed
44
+
representative at an online or offline event.
45
+
46
+
## Enforcement
47
+
48
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
49
+
reported to the IT Club faculty advisor. All complaints will be reviewed and
50
+
investigated promptly and fairly.
51
+
52
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may
53
+
face temporary or permanent repercussions as determined by the school administration.
54
+
55
+
## Attribution
56
+
57
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
58
+
version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
+35
CONTRIBUTING.md
+35
CONTRIBUTING.md
···
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 techclub@mergingtonhigh.example.edu
+28
SECURITY.md
+28
SECURITY.md
···
1
+
# Mergington High School Security Policy
2
+
3
+
## Reporting a Vulnerability
4
+
5
+
At Mergington High, we take the security of our Extra-Curricular Activities website seriously, especially
6
+
since it contains student information. If you discover a security vulnerability, please follow these steps:
7
+
8
+
1. **Do not** create an issue on this repository, disclose the vulnerability publicly, or discuss it with other teachers/students.
9
+
1. In the top navigation of this repository, click the **Security** tab.
10
+
1. In the top right, click the **Report a vulnerability** button.
11
+
1. Fill out the provided form. It will request information like:
12
+
- A description of the vulnerability
13
+
- Steps to reproduce the issue
14
+
- Potential impact on student data or website functionality
15
+
- Suggested fix (if you have one)
16
+
1. Email the IT Club faculty advisor at techsupport@mergingtonhigh.example.edu and inform them you have made a report. **Do not** include any vulnerability details.
17
+
18
+
## Response Timeline
19
+
20
+
- We will acknowledge receipt of your report within 2 school days
21
+
- We will provide an initial assessment within 5 school days
22
+
- Critical issues affecting student data will be addressed immediately
23
+
- We will create a private fork to solve the issue and invite you as a collaborator so you can see our progress and contribute.
24
+
25
+
## Thank You
26
+
27
+
Your help in keeping our school's digital resources secure is greatly appreciated!
28
+
Responsible disclosure of security vulnerabilities helps protect our entire school community.