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
-10Lines changed: 0 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@ Contributions to the frontend are welcome — bug fixes, accessibility improveme
4
4
5
5
> **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`.
`dist/` is gitignored, so copying the fixture there will never accidentally be committed.
71
69
72
-
---
73
-
74
70
## Testing
75
71
76
72
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.
90
86
91
87
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.
92
88
93
-
---
94
-
95
89
## Code conventions
96
90
97
91
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
108
102
-**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.
109
103
-**Build script is build-time only.**`build.ts` handles fetching data, generating RSS, and cache-busting. No runtime logic belongs there.
110
104
111
-
---
112
-
113
105
## Filing issues
114
106
115
107
-**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).
116
108
-**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.
0 commit comments