chore: update github PR template #4885
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lrstewart
commented
Nov 11, 2024
Comment on lines
+23
to
+27
| * Any change to the library source code should at least include unit tests. | ||
| * Any change to the core stuffer or blob methods should include [CBMC proofs](https://github.com/aws/s2n-tls/tree/main/tests/cbmc). | ||
| * Any change to the CI or tests should: | ||
| 1. prove that the test succeeds for good input | ||
| 2. prove that the test fails for bad input (eg, a test for memory leaks fails when a memory leak is committed) |
There was a problem hiding this comment.
Can anyone think of other high level testing guidelines that I'm forgetting?
There was a problem hiding this comment.
I think what you've got is good. Definitely better than what we have already!
camshaft
approved these changes
Nov 11, 2024
maddeleine
reviewed
Nov 11, 2024
maddeleine
approved these changes
Nov 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
The team plans to include summaries in future release notes, so we want PR authors to facilitate that process by providing the summaries where necessary. Note: there is a description of the "Release Summary" section, but I wrote it as a comment so it's not visible in the preview view.
While I was modifying the template, I also made a few other tweaks that I think will be helpful.
Testing:
Just documentation
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.