Update PULL_REQUEST_TEMPLATE.md

bitwiseman · web-flow · commit 51a0f949d8e1 · 2023-06-02T16:59:03.000-07:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,8 @@
 # Before submitting a PR:
 
 - [ ] Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, [CONTRIBUTING.md](CONTRIBUTING.md) for details.
-- [ ] Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .  
+- [ ] Add JavaDocs and other comments explaining the behavior. 
+- [ ] When adding or updating methods that fetch entities, add `@link` JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest . 
 - [ ] Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 - [ ] Run `mvn -D enable-ci clean install site` locally. If this command doesn't succeed, your change will not pass CI.
 - [ ] Push your changes to a branch other than `main`. You will create your PR from that branch.
@@ -14,6 +15,6 @@
 
 - [ ] Fill in the "Description" above with clear summary of the changes. This includes:
   - [ ] If this PR fixes one or more issues, include "Fixes #<issue number>" lines for each issue. 
-  - [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
+  - [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
 - [ ] All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
 - [ ] Enable "Allow edits from maintainers".
