Skip to content

Commit bca5854

Browse files
committed
Update CONTRIBUTING.md
1 parent 716707d commit bca5854

1 file changed

Lines changed: 0 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Contributions to the frontend are welcome — bug fixes, accessibility improveme
44

55
> **Looking to contribute data?** Adventure entries, corrections, and new taxonomy values belong in [`torchfinder-data`](https://github.com/Lodes-and-Lanterns/torchfinder-data). See that repo's `CONTRIBUTING.md`.
66
7-
---
8-
97
## Local setup
108

119
**Prerequisites:** [Deno](https://deno.com/) v2+.
@@ -69,8 +67,6 @@ deno run --allow-net --allow-read jsr:@std/http/file-server --port 8000
6967

7068
`dist/` is gitignored, so copying the fixture there will never accidentally be committed.
7169

72-
---
73-
7470
## Testing
7571

7672
Unit tests cover the pure-logic modules. Run them with:
@@ -90,8 +86,6 @@ No flags required — the tested modules don't access the filesystem or network.
9086

9187
The DOM-manipulating functions in `render.js` and all of `handlers.js` are not covered — they require a browser environment. If you add or change logic in any of the tested modules, add a test for it.
9288

93-
---
94-
9589
## Code conventions
9690

9791
The design principle is [KISS](https://en.wikipedia.org/wiki/KISS_principle): keep the stack as simple as the problem allows.
@@ -108,15 +102,11 @@ The design principle is [KISS](https://en.wikipedia.org/wiki/KISS_principle): ke
108102
- **Accessibility is not optional.** The app targets WCAG 2.1 AA. Any change that introduces keyboard navigation regressions, missing ARIA attributes, or broken focus management will be asked to fix before merge.
109103
- **Build script is build-time only.** `build.ts` handles fetching data, generating RSS, and cache-busting. No runtime logic belongs there.
110104

111-
---
112-
113105
## Filing issues
114106

115107
- **Site bugs** (broken layout, filter logic errors, accessibility issues, build failures): [open an issue in this repo](https://github.com/Lodes-and-Lanterns/torchfinder/issues/new).
116108
- **Data issues** (wrong metadata, missing entry, incorrect field value): use the "Report an issue" link on the entry's card in the app, or [open an issue in torchfinder-data](https://github.com/Lodes-and-Lanterns/torchfinder-data/issues/new) directly.
117109

118-
---
119-
120110
## Pull requests
121111

122112
1. Fork the repository and create a branch.

0 commit comments

Comments
 (0)