You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-15Lines changed: 21 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
16
16
17
17
## How to submit a Pull Request
18
18
19
-
> **Prereqs**: 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).
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).
21
21
22
22
1.**Fork** the repository.
23
23
@@ -57,7 +57,13 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
57
57
pytest
58
58
```
59
59
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:
61
67
62
68
```bash
63
69
# one-time install
@@ -72,32 +78,32 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
72
78
73
79
*Skip this step if your PR only touches Python code.*
74
80
75
-
9.**Run the local server** to sanity-check:
81
+
10.**Run the local server** to sanity-check:
76
82
77
-
```bash
78
-
cd src
79
-
uvicorn server.main:app
80
-
```
83
+
```bash
84
+
cd src
85
+
uvicorn server.main:app
86
+
```
81
87
82
-
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
88
+
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
83
89
84
-
10.**Commit** (signed):
90
+
11. **Commit** (signed):
85
91
86
92
```bash
87
93
git commit -S -m "Your commit message"
88
94
```
89
95
90
-
If *pre-commit* complains, fix the problems and repeat **6 – 9**.
96
+
If *pre-commit* complains, fix the problems and repeat **6 – 10**.
91
97
92
-
11. **Push** your branch:
98
+
12. **Push** your branch:
93
99
94
100
```bash
95
101
git push origin your-branch
96
102
```
97
103
98
-
12. **Open a pull request** on GitHub with a clear description.
104
+
13. **Open a pull request** on GitHub with a clear description.
99
105
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.
101
107
102
108
*(Optional) Invite a maintainer to your branch for easier collaboration.*
103
109
@@ -107,4 +113,4 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
107
113
108
114
- **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.
109
115
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