Skip to content

Commit 8dd4815

Browse files
authored
chore: update github PR template (#4885)
1 parent bcbf0d9 commit 8dd4815

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
1+
### Release Summary:
2+
<!-- If this is a feature or bug that impacts customers and is significant enough to include in the "Summary" section of the next version release, please include a brief (1-2 sentences) description of the change. The audience of this summary is future customers, not maintainers or reviewers. See https://github.com/aws/s2n-tls/releases/tag/v1.5.7 for an example. Otherwise, leave this section blank -->
3+
14
### Resolved issues:
25

3-
Resolves #ISSUE-NUMBER1, resolves #ISSUE-NUMBER2, etc.
6+
resolves #ISSUE-NUMBER1, resolves #ISSUE-NUMBER2, etc.
47

58
### Description of changes:
69

710
Describe s2n’s current behavior and how your code changes that behavior. If there are no issues this PR is resolving, explain why this change is necessary.
811

912
### Call-outs:
1013

11-
Address any potentially confusing code. Is there code added that needs to be cleaned up later? Is there code that is missing because it’s still in development?
14+
Address any potentially confusing code. Is there code added that needs to be cleaned up later? Is there code that is missing because it’s still in development? If a callout is specific to a section of code, it might make more sense to leave a comment on your own PR file diff.
1215

1316
### Testing:
1417

15-
How is this change tested (unit tests, fuzz tests, etc.)? Are there any testing steps to be verified by the reviewer?
16-
18+
How is this change tested (unit tests, fuzz tests, etc.)? What manual testing was performed? Are there any testing steps to be verified by the reviewer?
19+
How can you convince your reviewers that this PR is safe and effective?
1720
Is this a refactor change? If so, how have you proved that the intended behavior hasn't changed?
1821

22+
Remember:
23+
* Any change to the library source code should at least include unit tests.
24+
* Any change to the core stuffer or blob methods should include [CBMC proofs](https://github.com/aws/s2n-tls/tree/main/tests/cbmc).
25+
* Any change to the CI or tests should:
26+
1. prove that the test succeeds for good input
27+
2. prove that the test fails for bad input (eg, a test for memory leaks fails when a memory leak is committed)
28+
29+
1930
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

0 commit comments

Comments
 (0)