pr-task-completion
Included in configs: ✅ recommended, 🔒 strict
Repositories often provide a set of tasks that pull request authors are expected to complete.
Those tasks should be marked as completed with a [x] in the pull request description.
Repositories often include a template file for pull requests, commonly .github/PULL_REQUEST_TEMPLATE.md.
Contributors are expected to fill out that template file for their pull request descriptions.
Template files with - [ ] task lists are generally expected to [x] fill out every item in the list to confirm they’ve taken that step.
- [x] Added testsOptional Task Lists
Section titled “Optional Task Lists”GitHub-flavored Markdown does not provide a way to indicate which task list items are optional or required.
This rule cannot statically determine which tasks must have a [x].
If you don’t believe a task needs to be completed, consider marking the task’s text with ~~ strikethrough and explaining why.
For example, the following markdown:
- [x] ~~Added tests~~ Docs-only change…is rendered as:
-
Added testsDocs-only change
Examples
Section titled “Examples”Pull request missing task list items:
How to Enable
Section titled “How to Enable”Each snippet in this section shows changes to the full .github/workflows/octoguide.yml workflow from Get Started.
This rule is enabled by default as part of the recommended config.
To use this rule on its own, enable it in rules with the none config:
jobs: octoguide: runs-on: ubuntu-latest steps: - uses: OctoGuide/bot@0.33.1 with: config: none github-token: ${{ secrets.GITHUB_TOKEN }} rules: | { "pr-task-completion": true }
[ pr-task-completion ]
This PR’s body is missing
[x]checks on the following tasks from the PR template.Repositories often provide a set of tasks that pull request authors are expected to complete. Those tasks should be marked as completed with a
[x]in the pull request description. Please complete those tasks and mark the checks as[x]completed.