Conversation
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| <!-- for significant features includes a release summary --> | ||
| <!-- The release summary must be a single line that starts with "release summary" --> | ||
| <!-- release summary: s2n-tls customers can now frobincate the wobble --> |
There was a problem hiding this comment.
| <!-- release summary: s2n-tls customers can now frobincate the wobble --> | |
| <!-- release summary: s2n-tls users can now dance the tango --> |
Are we going to get tired of this joke if we see it on every PR xD?
There was a problem hiding this comment.
I'd like to keep the release summary on the top :)
There was a problem hiding this comment.
Hmm, @CarolYeh910 out of the last 10 PR's we merged in, only 2 of them had a release summary. And then another 2 kept the release summary blank but didn't actually remove the section 😆 .
Since it's ignored in the majority of PRs, that's why I voted to move it lower. Thoughts?
There was a problem hiding this comment.
Release summary is usually needed for feature PRs, thus the sample of last 10 PRs could be biased 😉 If it's present, I kinda want to move it higher. On the other hand, I can imagine the content of release summary is overlapped with the goal, so I'm fine with either way :)
There was a problem hiding this comment.
I wonder if the solution is somewhere in the middle? Like we include <A> in the PR title to indicate that it's
something we want to "announce"? And then we could just populate the release notes from the goal?
feat(s2n-tls): <A> allow pure PQ security policies
Or something like that 🤷
There was a problem hiding this comment.
Interesting idea! Hopefully it works with Doug's release automation script 😆
Co-authored-by: maddeleine <59030281+maddeleine@users.noreply.github.com>
Goal
Simplify the PR template
Why
Our current PR template includes lots of "developer documentation" which is not applicable to most PRs. Additionally, the most important item to document for a PR is why it is being done. This new PR format forces contributors to specify that.
How
We delete the old template and add a new one
Note that this might require some changes to the release note script
Testing
None
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.