Skip to content

Commit c196248

Browse files
committed
docs: add a development section
1 parent 1256a60 commit c196248

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

‎DOCUMENTATION.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ request question: instead of *"which files does this PR change?"*, it tells you
1313
- [Authentication](#authentication)
1414
- [Forges](#forges)
1515
- [Internationalization](#internationalization)
16+
- [Development](#development)
1617
- [Install](#install)
1718
- [Troubleshooting](#troubleshooting)
1819

@@ -224,6 +225,23 @@ If you add a translatable string:
224225
- add the string to `_locales/template.json`
225226
- update `_locales/en/messages.json` with a description and a translation
226227

228+
## Development
229+
230+
The dev tools (ESLint, web-ext) are npm dev dependencies; install them once
231+
with `npm ci`. Then:
232+
233+
- `npm test` — run the test suite (`npm run test:coverage` adds coverage)
234+
- `npm run lint` — lint the scripts with ESLint
235+
- `npm run lint:webext` — validate the extension with `web-ext lint`. It
236+
always warns that Firefox ignores the Chrome-only
237+
`background.service_worker` manifest key; the CI lint workflow strips that
238+
key first and escalates any other warning to an error
239+
- `npm run build` — package the extension into `web-ext-artifacts/`
240+
(the development files listed in `.web-ext-config.mjs` stay out)
241+
242+
The CI workflows run the same scripts: lint and test on every push, build on
243+
the main branch and tags.
244+
227245
## Install
228246
### Firefox
229247

0 commit comments

Comments
 (0)