chore: add PR template, guidance, and gitar rule for quality checks#286
Merged
Bueller87 merged 1 commit intocadence-workflow:masterfrom Mar 17, 2026
Merged
Conversation
- Add .github/pull_request_template.md with sections for sample area, what changed, why, testing, risks, release notes, and docs - Add .github/pull_request_guidance.md with samples-specific guidance and examples (Gradle commands, N/A when appropriate) - Add .gitar/rules/pr-description-quality.md to evaluate PR descriptions against the guidance Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com>
Code Review ✅ ApprovedAdds PR template, guidance, and gitar rule to establish quality check standards for the repository. No issues found. Rules ✅ All 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 |
c-warren
approved these changes
Mar 16, 2026
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.
Which sample(s) or area?
.github, .gitar (repo tooling)
What changed?
Added a minimal PR template, a guidance doc that explains how to fill it out, and a gitar rule that evaluates PR descriptions against that guidance.
Why?
Automate PR quality so contributors get a clear, lightweight template and reviewers get consistent context (what changed, why, how it was tested). The guidance keeps the template short while documenting expectations (e.g. Gradle commands, when to use N/A). The gitar rule enforces those expectations on PR description creation/update.
How did you test it?
.github/pull_request_template.md,.github/pull_request_guidance.md,.gitar/rules/pr-description-quality.mdPotential risks
N/A — tooling only; no runtime or build impact.
Release notes
N/A — internal process improvement.
Documentation Changes
N/A — these files are the new documentation for PR process; no updates to README or sample docs required.