docs: Move pull request template documentation to its own guidance file#7717
Open
c-warren wants to merge 2 commits intocadence-workflow:masterfrom
Open
docs: Move pull request template documentation to its own guidance file#7717c-warren wants to merge 2 commits intocadence-workflow:masterfrom
c-warren wants to merge 2 commits intocadence-workflow:masterfrom
Conversation
Code Review ✅ ApprovedClean documentation reorganization that moves PR guidance to a dedicated file while keeping the template minimal. Content was faithfully moved and references are correctly updated. Rules ❌ No requirements metRepository Rules
OptionsAuto-apply is off → Gitar will not commit updates to this branch. Comment with these commands to change:
Was this helpful? React with 👍 / 👎 | Gitar |
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
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.
What changed?
Moves pull request guidance from the template to its own documentation.
Why?
The comments within a git description are taking up a significant amount of space in the git log and reducing its readability. This change moves the instructions to a guidance document so that maintainers/contributors can reference the guidance without cluttering the log. It also updates our .gitar rule so that gitar will reference the new file when recommending updates to a pull request description.
How did you test it?
This PR will act as the test - gitar should pick up on the changes and correctly identify that Potential Risks was left empty.
Potential risks
Release notes
N/A
Documentation Changes
N/A
Reviewer Validation
PR Description Quality (check these before reviewing code):
go testinvocation)