From 971814255c39c1b2a6542a0fc61b1f563586387d Mon Sep 17 00:00:00 2001 From: Devon Bautista <17506592+synackd@users.noreply.github.com> Date: Mon, 24 Aug 2026 13:29:32 -0600 Subject: [PATCH] docs: refactor PR template to be submitter-focused 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> --- pull_request_template.md | 49 +++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 0ead990..1364487 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,35 +1,32 @@ -## Pull Request Template +## Description -Thank you for your contribution! Please ensure the following before submitting: - -### 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 `.license` sidecar - - [ ] All referenced licenses are present in the `LICENSES/` directory - -### Description - -Please include a summary of the change and which issue is fixed. +Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. -Fixes #(issue) +Fixes # -### Type of Change +## Checklist -- [ ] Bug fix -- [ ] New feature -- [ ] Breaking change -- [ ] Documentation update +- [ ] 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 `.license` sidecar + - [ ] All referenced licenses are present in the `LICENSES/` directory + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Breaking change +- [ ] Documentation update - [ ] Dependency update +- [ ] Build system/CI --- -For more info, see [Contributing Guidelines](https://github.com/OpenCHAMI/.github/blob/main/CODE_OF_CONDUCT.md). +- [x] I agree to follow the [Code of Conduct](https://github.com/OpenCHAMI/.github/blob/main/CODE_OF_CONDUCT.md).