Skip to content

Sunday, 17 May

Situation

Numbers written as digits in places they shouldn't be. Bug entries and improvement entries blending into each other. Also wanted to spend time on git outside of just using it for commits.

Task

Pin down new small rules — number style, bug entry shape, improvement entry shape. Practice git and start a dedicated git page in the docs.

Action

Numbers — should be spelled out. "three" not "3". At least for low numbers in prose.

Bug entries — always start with "Fixed". Two shapes I keep seeing: - Fixed [device] [problem] — e.g. "Fixed Drum Sampler crash on load." - Fixed [adjective] [noun] — e.g. "Fixed incorrect parameter naming."

Improvements / features — lead with the improved thing, not the action. The feature is the subject.

Git — practiced branching, merging, and pushing on the side. Made a Git page in the docs to write down what I actually understand.

Result

Three small rules locked in:

  1. Numbers spelled out ("three", not "3").
  2. Added a new rule in the Bug Fix section (rule 9 and 10)
  3. New Git page in the docs — notes from actual use, not copy-pasted commands.