Pull Checklist

Pull Request Integration

Learn how Pull Checklist works with your pull requests.

Automatic Integration

When your team raises a pull request, Pull Checklist seamlessly integrates into the workflow. The relevant checklist will automatically appear when the conditions you defined are met.

CI Check Integration

Pull Checklist functions as a Continuous Integration (CI) check in your pull requests:

How It Works

  • Appears alongside other CI checks
  • Updates status based on checklist completion
  • Blocks merging if enforced and incomplete
  • Provides quick access to checklist items

Display Conditions

Checklists can be configured to appear based on:

  • Number of lines changed
  • Files modified
  • PR title keywords
  • Branch patterns
  • And more

Working with Checklists in PRs

For PR Authors

  1. Create your pull request as normal
  2. View the checklist in the PR checks section
  3. Complete required items
  4. Address any blockers

For Reviewers

  1. Review the checklist status
  2. Verify completed items
  3. Add comments or requests
  4. Approve when satisfied

Best Practices

When working with PR checklists:

  • Complete items as you go
  • Don't wait until the end
  • Communicate blockers early
  • Use comments for context
  • Keep the PR scope focused

Troubleshooting

Common scenarios and solutions:

  • Checklist not appearing: Check display conditions
  • Can't complete items: Verify permissions
  • Merge blocked: Review enforcement rules
  • Missing checks: Update checklist configuration

Next Steps

Learn more about: