Skip to content

Commit e219874

Browse files
pr fixes
1 parent 5c081a8 commit e219874

File tree

7 files changed

+43
-1724
lines changed

7 files changed

+43
-1724
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,9 @@ node_modules/
173173
# CSS
174174
src/static/css/site.css
175175

176+
# Lock files
177+
package-lock.json
178+
176179
# Project specific
177180
history.txt
178181
cleanup.py

CONTRIBUTING.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
1616

1717
## How to submit a Pull Request
1818

19-
> **Prereqs**: The project uses **Python 3.9+** and `pre-commit` for development.
20-
> If you plan to touch the frontend, youll also need **Node ≥18** (for Tailwind).
19+
> **Prerequisites**: The project uses **Python 3.9+** and `pre-commit` for development.
20+
> If you plan to touch the frontend, you'll also need **Node ≥18** (for Tailwind).
2121
2222
1. **Fork** the repository.
2323

@@ -57,7 +57,13 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
5757
pytest
5858
```
5959

60-
8. **If you edited templates or CSS** rebuild Tailwind:
60+
8. *(Optional)* **Run `pre-commit` on all files** to check hooks without committing:
61+
62+
```bash
63+
pre-commit run --all-files
64+
```
65+
66+
9. **If you edited templates or CSS** rebuild Tailwind:
6167

6268
```bash
6369
# one-time install
@@ -72,32 +78,32 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
7278

7379
*Skip this step if your PR only touches Python code.*
7480

75-
9. **Run the local server** to sanity-check:
81+
10. **Run the local server** to sanity-check:
7682

77-
```bash
78-
cd src
79-
uvicorn server.main:app
80-
```
83+
```bash
84+
cd src
85+
uvicorn server.main:app
86+
```
8187

82-
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
88+
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
8389

84-
10. **Commit** (signed):
90+
11. **Commit** (signed):
8591

8692
```bash
8793
git commit -S -m "Your commit message"
8894
```
8995

90-
If *pre-commit* complains, fix the problems and repeat **6 – 9**.
96+
If *pre-commit* complains, fix the problems and repeat **6 – 10**.
9197

92-
11. **Push** your branch:
98+
12. **Push** your branch:
9399

94100
```bash
95101
git push origin your-branch
96102
```
97103

98-
12. **Open a pull request** on GitHub with a clear description.
104+
13. **Open a pull request** on GitHub with a clear description.
99105

100-
13. **Iterate** on any review feedback—update your branch and repeat **6 – 12** as needed.
106+
14. **Iterate** on any review feedback—update your branch and repeat **6 – 13** as needed.
101107

102108
*(Optional) Invite a maintainer to your branch for easier collaboration.*
103109

@@ -107,4 +113,4 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
107113

108114
- **Do not commit `src/static/css/site.css`.** The CI pipeline runs `npm run build:css` during the container/image build, so the artefact is produced automatically.
109115

110-
- When developing locally you may run the build yourself (see step 8) so you can preview the styles.
116+
- When developing locally you may run the build yourself (see step 9) so you can preview the styles.

0 commit comments

Comments
 (0)