Skip to content

chore: add PR template, guidance, and gitar rule for quality checks#286

Merged
Bueller87 merged 1 commit intocadence-workflow:masterfrom
Bueller87:add-pr-template-plus-gitar-rules
Mar 17, 2026
Merged

chore: add PR template, guidance, and gitar rule for quality checks#286
Bueller87 merged 1 commit intocadence-workflow:masterfrom
Bueller87:add-pr-template-plus-gitar-rules

Conversation

@Bueller87
Copy link
Contributor

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?

  • Confirmed files exist and content matches the plan: .github/pull_request_template.md, .github/pull_request_guidance.md, .gitar/rules/pr-description-quality.md
  • No workflow or code changes; additive only.

Potential 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.

- 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>
@gitar-bot
Copy link

gitar-bot bot commented Mar 16, 2026

Code Review ✅ Approved

Adds PR template, guidance, and gitar rule to establish quality check standards for the repository. No issues found.

Rules ✅ All requirements met

Repository Rules

PR Description Quality Standards: All required sections contain substantive content and N/A is correctly applied for non-applicable sections.
Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@Bueller87 Bueller87 merged commit 722029e into cadence-workflow:master Mar 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants