Skip to content

docs: refactor PR template to be submitter-focused - #41

Open
synackd wants to merge 1 commit into
mainfrom
docs/refactor-pr-template
Open

docs: refactor PR template to be submitter-focused#41
synackd wants to merge 1 commit into
mainfrom
docs/refactor-pr-template

Conversation

@synackd

@synackd synackd commented Aug 24, 2026

Copy link
Copy Markdown

Description

Instead of the pull request template being documentation-focused (e.g. title "Pull Request Description"), make it submitter-focused so the PR submitter need not delete so much template text. Also, move description to top to ease at-a-glance previewing.

Add "Build system/CI" change type.

Change code of conduct link to be a check box to indicate agreement.

Checklist

  • My code follows the style guidelines of this project
  • I have added/updated comments where needed
  • I have added tests that prove my fix is effective or my feature works
  • I have run make test (or equivalent) locally and all tests pass
  • I have updated the relevant documentation (CLI examples, man pages, README, other docs, etc.)
  • DCO Sign-off: All commits are signed off (git commit -s) with my real name and email
  • REUSE Compliance:
    • Each new/modified source file has SPDX copyright and license headers
    • Any non-commentable files include a <filename>.license sidecar
    • All referenced licenses are present in the LICENSES/ directory

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Dependency update

For more info, see Contributing Guidelines.

Instead of the pull request template being documentation-focused (e.g.
title "Pull Request Description"), make it submitter-focused so the PR
submitter need not delete so much template text. Also, move description
to top to ease at-a-glance previewing.

Add "Build system/CI" change type.

Change code of conduct link to be a check box to indicate agreement.

Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
@synackd
synackd requested a review from a team as a code owner August 24, 2026 19:38
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.

1 participant