Skip to main content
Skip table of contents

Getting started - GitHub


Checklist Buddy adds tasks and comments to pull requests depending on the context of the pull request.

Based on rules defined by the user in a simple configuration file, the app adds:

  • Tasks
  • Comments
  • Checklists: A checklist includes a title and a list of tasks

Formatting support for links, emojis, user mentions (markdown style) in comments. Tasks only support plain text.

Get started

Initial configuration

  1. Create a new file named PRCHECKLIST in the root folder of your git repository. The file should include as content a simple task, like:

    +task+ Hug your Checklist Buddy once a day.

    This will help you run a test to ensure the initial setup was successful. You will later be able to customize this file to add all the tasks, checklists and comments you want for your pull requests.

  2. Commit the newly created PRCHECKLIST file to the default branch.

You can also manage your PRCHECKLIST file using our Online Checklist Editor.

First pull request checklist

  1. Create a new pull request to test that the app is properly configured.

  2. You should now see the task created by Checklist Buddy.

Create your own checklists

You are all set now! You can adapt the PRCHECKLIST file to your needs for pull requests that match certain criteria.

OPTIONAL: To enforce resolving the tasks in the checklists, enable the merge check No incomplete tasks (Bitbucket DC) or No unresolved pull request tasks (Bitbucket Cloud).

Check the Syntax reference for more information about the PRCHECKLIST syntax.

Pull request with an individual task and a checklist added by Checklist Buddy.

Prevent Merges with unfinished Tasks

  1. Add a branch protection rule under Repository Settings → Branches → Branch protection rules → Add Rule

  2. Enable Require status checks to pass before merging


Check the roadmap for more information.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.