picnoir
/
Nix
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

Mention internal API docs in PR template 

I think we want to ensure that all new items in headers are documented,
and the documentation on modified items is kept up to date.

It will take a while to document the backlog of undocumented things, but
we can at least ensure that new items don't extend that backlog.
This commit is contained in:
John Ericson 2023-04-02 19:44:44 -04:00
parent 2ef99cd104
commit ca3937fb82
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -23,6 +23,7 @@ Maintainers: tick if completed or explain if not relevant
- unit tests - `src/*/tests`
- integration tests - `tests/nixos/*`
- [ ] documentation in the manual
- [ ] documentation in the internal API docs
- [ ] code and comments are self-explanatory
- [ ] commit message explains why the change was made
- [ ] new feature or incompatible change: updated release notes