chore(github): Update PR template per new documentation workflow#3241
Merged
chore(github): Update PR template per new documentation workflow#3241
Conversation
Savio-Sou
added
enhancement
documentation
signorecello
approved these changes
Oct 24, 2023
Contributor
signorecello
left a comment
signorecello
left a comment
There was a problem hiding this comment.
I'm reviewing but I think we should have @kevaundray's input on this
guipublic
pushed a commit
that referenced
this pull request
Oct 26, 2023
guipublic
pushed a commit
that referenced
this pull request
Oct 27, 2023
guipublic
pushed a commit
that referenced
this pull request
Oct 30, 2023
2 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Context
To better promote secure and best development practices through documentation, Noir's contribution workflow now requires code authors to include documentation updates per their code changes (if applicable) in the same PRs.
The workflow would be very helpful for capturing design philosophies, contexts, details and caveats from the original authors in the Noir documentation that otherwise could easily go missing in translation.
Summary*
This PR updates the GitHub PR template to reflect the new workflow.
Additionally the PR also trims the verbose comments in the template.
Additional Context
Related effort: #3162
PR Checklist*
cargo fmton default settings.