Dummu - Naming Convention in YAML

A name is the first and cheapest form of documentation a reader ever gets.

Why this matters for YAML

This is a bold claim, an italic aside, and an underlined point, all in one YAML example.

What it touches:

• The YAML runtime or interpreter
• Whatever calls the code around it
• Anyone reading this six months from now

How to apply it:

1. Read the snippet below once, slowly.
2. Try changing one value and predict the output before running it.
3. Compare your prediction against what actually happens.

"If the name needs a comment to explain it, the name is wrong."

steps:
  - name: install
    run: npm ci
  - name: test
    run: npm test

Reference: YAML documentation

If the name needs a comment to explain it, the name is wrong.