Suggest code quality improvements in code quality widget MR view

Problem to solve

Delaney and Sasha want to improve the quality of their project but don't know where to start or if there are easy things they can do to increase quality without a lot of manual effort.

Intended users

• Delaney (Development Team Lead)
• Sasha (Software Developer)

Further details

Gitlab can make use of the knowledge of the existing code base and patterns that have high code quality to make suggestions to Sasha at build time if code quality is not maintained or increased by the current MR.

Proposal

• Sasha creates an MR with changes.
• The code quality plugin does it's thing
• Gitlab makes use of the patterns in the code base of the project / similar projects in the group to identify high quality patterns of code that are similar to the contribution in the MR.
• These examples are provided in the Code Quality widget of the MR
  • This can be informational or required
• Sasha iterates on the MR until code quality is where they like it.

Permissions and Security

Documentation

Testing

What does success look like, and how can we measure that?

• Delaney and Sasha will be successful if this feature decreases the lead time to complete an MR by 10%
• Gitlab will be successful if > 25% of groups eligible to use this feature do so actively.

What is the type of buyer?

The Buyer of this feature is a VP / Director of software who sees the value in test driven development to help improve velocity of feature delivery.

Links / references