Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Celebration

Earn badges and make progress

You're on your way to the next level! Join the Kudos program to earn points and save your progress.

Deleted user Avatar
Deleted user

Level 1: Seed

25 / 150 points

Next: Root

Avatar

1 badge earned

Collect

Participate in fun challenges

Challenges come and go, but your rewards stay with you. Do more to earn more!

Challenges
Coins

Gift kudos to your peers

What goes around comes around! Share the love by gifting kudos to your peers.

Recognition
Ribbon

Rise up in the ranks

Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!

Leaderboard

Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,461,791
Community Members
 
Community Events
176
Community Groups

Code Reviews - Time to put the things on Autopilot

Checklists are important instruments to uphold quality in code reviews. They help ensure that all the relevant tasks are carried out and that nothing is forgotten. However, doing those checklists manually is a tedious, time-consuming task. That's why many engineering teams have turned to automation using GitHub's pull request templates feature. While this is a step in the right direction, there are still some limitations with this approach. Let's take a closer look.

GitHub's Pull Request Templates Approach

 

GitHub's pull request templates are a way to automate the creation of checklists. With this feature, you can have a set of checklist items that will be automatically added to every pull request. The problem with this approach is that the checklist items are always the same, regardless of the actual pull request and its content. A one-size-fits-all checklist will not always be effective. Most of the time, the checklist may need to be changed to fit the pull request.

Context-Dependent Checklists to the Rescue!

 

Branch filters let you make checklists that change depending on the source or destination branch. In other words, you want different checklists depending on the source or destination branch. For example, when doing a hotfix, you might want a different checklist than when working on a new feature or release branch. This approach offers much more flexibility and can be tailored specifically to your needs.

checklist-buddy-blog-1.png

Also, the content of a file in a Pull Request can be used to decide which items on a checklist should be used. For example, if an image is added to a Pull Request, it might be important to check that images have been appropriately compressed. Overall, context-dependent checklists can help make code reviews better and more efficient by making sure that the right things are checked at the right time.

Checklist Buddy for GitHub is an innovative new tool that helps developers create effective checklists for their code repositories.

The app also offers a new merge check to prevent Pull Requests from being merged when there are unresolved tasks, e.g. in checklists.

Chechlist-buddy-blog-2.png

To top it off, our configuration is incorporated into a powerful syntax via code stored inside a file called 'PRCHECKLIST'. Each change you make here is peer reviewable with easy tracking ensured by Git!

 

--files ui/** +title+ Frontend testing checklist :art:

--files ui/** +task+ UI changes visually inspected on Chrome

--files ui/** +task+ UI changes visually inspected on Safari

If you're looking for a more flexible and tailored solution to code review checklists, Checklist Buddy could be the answer, and help you stay organized, efficient, and productive.

We created it also for  Bitbucket and JetBrains Space where we also won the Space App Contest. With a sample repository full of checklists  to reference or customize for all projects - big or small - use it as the perfect companion in streamlining workflows.

 

0 comments

Comment

Log in or Sign up to comment
TAGS

Atlassian Community Events