What it looks like
A description:
Describe each commit briefly, to the point, in our style, no fluff.
The model reads “briefly”, “to the point” and “our style” its own way. An example:
Commit messages look like this:
<example>
traefik: readTimeout 300s — uploads over 100 MB were cut off
</example>
<example>
crowdsec: forward hook — the ban didn't cover sites in containers
</example>
From two lines the model takes everything at once: the component prefix, the colon, what was done, the dash, why, no period, under 72 characters.
How many examples, and which
- One — when there’s one case and the format is simple.
- Two or three — when the cases differ: short and long, a good one and one with an error.
- Different in content. If all three examples are about Traefik, the model starts putting Traefik where it doesn’t belong.
- In
<example>tags: that’s how the model tells a sample from the task.
A bad example works too
A “don’t” example next to a “do” example shows the boundary: “not this: ‘fix’, ‘changes’; this: ‘traefik: readTimeout 300s — …’”. A single bad example without a good one is risky: the model may take its shape.