Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 51a0f94

Browse filesBrowse files
authored
Update PULL_REQUEST_TEMPLATE.md
1 parent 6f8c299 commit 51a0f94
Copy full SHA for 51a0f94

File tree

Expand file treeCollapse file tree

1 file changed

+3
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+3
-2
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+3-2Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
# Before submitting a PR:
66

77
- [ ] 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.
8-
- [ ] Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .
8+
- [ ] Add JavaDocs and other comments explaining the behavior.
9+
- [ ] When adding or updating methods that fetch entities, add `@link` JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
910
- [ ] Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
1011
- [ ] Run `mvn -D enable-ci clean install site` locally. If this command doesn't succeed, your change will not pass CI.
1112
- [ ] Push your changes to a branch other than `main`. You will create your PR from that branch.
@@ -14,6 +15,6 @@
1415

1516
- [ ] Fill in the "Description" above with clear summary of the changes. This includes:
1617
- [ ] If this PR fixes one or more issues, include "Fixes #<issue number>" lines for each issue.
17-
- [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
18+
- [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
1819
- [ ] 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."
1920
- [ ] Enable "Allow edits from maintainers".

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.