diff options
| author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-04-02 19:44:44 -0400 |
|---|---|---|
| committer | John Ericson <John.Ericson@Obsidian.Systems> | 2023-04-02 19:44:44 -0400 |
| commit | ca3937fb82574c765f625b2877cca06c5aeba2c6 (patch) | |
| tree | 8c937fd12d722e1a91df086acf836c644eb90964 /.github/PULL_REQUEST_TEMPLATE.md | |
| parent | 2ef99cd10489929a755831251c3fad8f3df2faeb (diff) | |
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.
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 60742cf6a..4488c7b7d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 |