Merge pull request #1542 from element-hq/rav/tsdoc_in_pr_template

PR template: reminder to document your stuff
element-hq · Feb 28, 2024 · d747a93 · d747a93
2 parents 643f9ef + 85f1b5c
commit d747a93
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,6 +2,7 @@
 
 ## Checklist
 
--   [ ] Ensure your code works with manual testing
--   [ ] Linter and other CI checks pass
--   [ ] Sign-off given on the changes (see [CONTRIBUTING.md](https://github.com/vector-im/element-desktop/blob/develop/CONTRIBUTING.md))
+-   [ ] Ensure your code works with manual testing.
+-   [ ] New or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation.
+-   [ ] Linter and other CI checks pass.
+-   [ ] Sign-off given on the changes (see [CONTRIBUTING.md](https://github.com/vector-im/element-desktop/blob/develop/CONTRIBUTING.md)).