Skip to content

Commit

Permalink
This PR adds a template for PR descriptions, aimed to provide suffici…
Browse files Browse the repository at this point in the history
…ent details

about the changes being made.
  • Loading branch information
shralex committed Nov 25, 2024
1 parent ee01072 commit a27476f
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Description

Start with a short description of what the PR does and how this is a change from
the past.

The rest of the description includes relevant details and context, examples:
- why is this change being made,
- the problem being solved and any relevant context,
- why this is a good solution,
- some information about the specific implementation,
- shortcomings of the solution and possible future improvements.

If the change fixes a bug or a Github issue, please include a link, e.g.,:
FIXES: b/123456
FIXES: #123456

# Tests

Please describe how you tested this change, and include any instructions and/or
commands to reproduce.

# Checklist

Before submitting this PR, please make sure (put X in square brackets):
- [ ] I have performed a self-review of my code.
- [ ] I have necessary comments in my code, particularly in hard-to-understand areas.
- [ ] I have run end-to-end tests tests and provided workload links above if applicable.
- [ ] I have made or will make corresponding changes to the doc if needed.
11 changes: 11 additions & 0 deletions .github/workflows/require-checklist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Require Checklist
on:
pull_request:
types: [opened, edited, synchronize]
jobs:
check_pr_body:
runs-on: ubuntu-latest
steps:
- uses: mheap/require-checklist-action@v2
with:
requireChecklist: true # If this is true and there are no checklists detected, the action will fail

0 comments on commit a27476f

Please sign in to comment.