Fork me on GitHub

Project Notes

#380 conventional: comments

A standardised way to write comments that are easy to grok and grep.

Notes

Conventional Comments was created by Paul Slaughter (who worked at GitLab) as a lightweight convention for structuring review/feedback comments (code reviews, editing feedback, pull/merge requests) with clear labels and intent.

The basic format is:

<label> [decorations]: <subject>

[discussion]

Where for example:

  • label could be: fix, feat etc
  • optional decorations could be (blocking), (non-blocking) etc

Status?

  • the idea has been adopted or at least considered by many teams
  • several browser extensions and tools exist to support Conventional Comments

See also: LCK#381 Conventional Commits

Credits and References

About LCK#380 vcsmethods

This page is a web-friendly rendering of my project notes shared in the LittleCodingKata GitHub repository.

Project Source on GitHub Return to the LittleCodingKata Catalog
About LittleCodingKata

LittleCodingKata is my collection of programming exercises, research and code toys broadly spanning things that relate to programming and software development (languages, frameworks and tools).

These range from the trivial to the complex and serious. Many are inspired by existing work and I'll note credits and references where applicable. The focus is quite scattered, as I variously work on things new and important in the moment, or go back to revisit things from the past.

This is primarily a personal collection for my own edification and learning, but anyone who stumbles by is welcome to borrow, steal or reference the work here. And if you spot errors or issues I'd really appreciate some feedback - create an issue, send me an email or even send a pull-request.

Follow the Blog follow projects and notes as they are published in your favourite feed reader
Some Other Sites
LittleArduinoProjects my collection of electronics projects, often involving an Arduino LittleModelArt my collection of scale modelling, miniatures and other art projects My Personal Blog occasional ramblings that don't belong anywhere else