search

SamaCare / eng-practices

Samacare's Engineering Practices documentation
https://google.github.io/eng-practices/
Other
1 stars 0 forks source link

CR title and summary consistency/enforcement #3

Open mhammer708 opened 7 months ago

mhammer708 commented 7 months ago

we have had conversations in the past re: how to name CRs and what to include in the body of a CR. I know this changes based on the engineer, so it would be great to codify for our team, since the above documentation is just Google’s and it’s nice when everyone feels heard.

should we enforce rules?

sidhuko commented 7 months ago

Just a note here from previous experiences.

  1. We have some tools that can work: https://www.npmjs.com/package/@commitlint/cli
  2. They can be added as git hooks however Github can change the commit message on squash so we must validate on CICD. The rule used to be with one commit in the PR it would just the commit message, anymore and it was use the title of the PR.