Skip to content

Commit 00f1856

Browse files
committed
docs: add details on documentation building
1 parent 7416331 commit 00f1856

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,21 @@ npm run build
2727
## Coding standards
2828

2929
The project follows ESLint rules from [`canonical`](https://www.npmjs.com/package/eslint-config-canonical)
30-
and testing follows its subconfig, `canonical/mocha`.
30+
and testing follows its subconfig, `canonical/mocha`. You can run
31+
`npm run lint` to check the linting if your IDE is not already indicating
32+
items needing fixing.
33+
34+
## Documentation building
35+
36+
In order to make changes that are reflected in the README, you will need to
37+
modify files within the `.README` directory. `.README/README.md` contains the
38+
main README skeleton and details on the project, its global `settings`, etc.,
39+
while the documentation for specific rules (that will get pulled into the
40+
README) ought to be modified within the relevant file within `.README/rules`.
41+
Once these files are modified, you can run `npm run create-readme` to have
42+
these files integrated into the main `/README.md`. While you should include
43+
the built file in your PR, you will do not want to make manual changes
44+
directly to this file as they will be overwritten.
3145

3246
## Testing
3347

0 commit comments

Comments
 (0)