Getting started

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 of the repository.

You can also manage your PRCHECKLIST file using our Online Checklist Editor. This will help you to see syntax errors immediately.

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).

Project Checklists

There are certain Checklists that you always define. For example, if you are using a CODEOWNERS file in your repositories to manage reviewers, you way want to draw the attention to a PR author when they alter or delete this file.

Project Checklists allows you to define once such checklist, and it will be reused for each repository in this project.

Note: you need to have admin rights at the project level to configure the Project Checklists.

How to use

1. Go to the Checklist Buddy settings page of your project.
   1. From the project page, click on the "Project Settings" icon on the left
   2. Under "ADD-ONS", click on "Checklist Buddy"
2. In the "Checklists shared across all repositories in project" section, click on the + icon on the right to add a new checklist
3. Fill in a title and under what conditions this checklist must be added to a Pull Request, then click on "Create checklist and start adding items"
4. Next to your checklist title, click the + icon to add a new comment or task for that pull request
5. Fill in the content and click "Add item", then click on "Save" on the right

The defined checklist will be added on any repository in this project (when the conditions are met).

Make sure that you have a PRCHECKLIST file in the default branch of the repository. Use our Online Checklist Editor to check for any syntax errors. If everything is fine, try this:

1. Navigate to the Pull Request
2. Find and expand the 'Checklist Buddy' panel on the right
3. Check if any errors are mentioned
4. Otherwise, contact Mibex support