search

RefactoringCombos / ArlosCommitNotation

A notation for small commits messages that show the risk involved in each step
321 stars 30 forks source link

Are we optimizing for typing or readability? #20

Closed rogerdubbs closed 1 year ago

rogerdubbs commented 4 years ago

I tried this and my reviewer gave this feedback.

Also: "i really don't want to have to go to a legend to see what these mean"

I get that this notation can be learned but wanted to pass along the feedback.

JayBazuzi commented 4 years ago

If you're committing every 30 seconds, anything more than r is annoying to type.

In a gnarly slow build, REFACTOR:ReSharper - Extract Method is fine to type.

arlobelshee commented 3 years ago

I also find the one-letter codes improve readability after they are consistent. There is a 4-char column at the left of the commit long. You can vertically scan it to review risk. I find that much easier to read than if we used words and I had to actually read / interpret each line independently.