Skip to content

Add PR template#161

Closed
tmeisel wants to merge 3 commits intomainfrom
chore/ace-3-pr-template
Closed

Add PR template#161
tmeisel wants to merge 3 commits intomainfrom
chore/ace-3-pr-template

Conversation

@tmeisel
Copy link
Copy Markdown
Contributor

@tmeisel tmeisel commented Feb 16, 2026

Issue

Description

This PR adds a pull request template to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. This PR follows the suggested template.

Checklist

  • PR required dependency updates
  • I've added tests that cover the changes
  • I've updated the documentation to reflect the new behavior

Additional Authors

none

@tmeisel tmeisel self-assigned this Feb 16, 2026
@github-actions github-actions Bot added the chore A routine task or common potentially re-occurring task label Feb 16, 2026
@@ -0,0 +1,19 @@
## Issue

- [ ] [Solutions Arsenal xx](https://github.com/opendefensecloud/solution-arsenal/issues/xx)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solutions Arsenal -> Solution Arsenal?

Maybe just the link is fine as well, as github renders it properly anyway, e.g. #155

Comment thread .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Comment thread .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Comment thread .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@trevex
Copy link
Copy Markdown
Contributor

trevex commented Feb 26, 2026

@olzemal used the template in #195

The checkboxes have the side-effects that the PR has status 3/7 which confused me, as I thought the PR is not yet ready... We should at least not use checkboxes for multiple choise and should probably include a note to remove checkboxes that are not applicable.

Comment thread .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@dermorz
Copy link
Copy Markdown
Contributor

dermorz commented Mar 12, 2026

May I suggest a different approach? I would keep the checkboxes minimal and only keep those that are always applicable, so from the PR list-view we can see a 2/2.

Other than that I would give the contributer prompts to leave relevant information for the reviewer.

Things like linter, coverage, fmt, codegen should be checked automatically and should not have their explicit checkboxes.

For example:

## What
<!-- One sentence summary -->
Closes #

## Why
<!-- Motivation / problem being solved. Skip if obvious from the linked issue. -->

## Testing
<!-- How was this tested? e.g. unit, envtest, manual against vX.Y.Z -->

## Notes for reviewers
<!-- CRD/API changes, RBAC changes, new watches, breaking changes, upgrade path.
     Delete if not applicable. -->

## Checklist
- [ ] Tests added/updated
- [ ] No breaking changes (or upgrade path documented above)

@trevex
Copy link
Copy Markdown
Contributor

trevex commented Apr 7, 2026

We should also add "readable commit history (squashed, rebased as required)"

@trevex trevex closed this Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore A routine task or common potentially re-occurring task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants