By name: commit description: MUST invoke before creating any git commit. Provides commit message format and safety rules.
Message guideline
Title format
Use "component: Brief summary" format for the commit title.
Examples:
- "completions: Add support for keyword argument completion"
- "diagnostics: Fix false positive on unused variable"
- "ci: Update GitHub Actions workflow"
Body
Use a single body structure for feature additions, bug fixes, and other behavior changes. Do not introduce separate required formats for each kind.
Write paragraphs in this order:
- Explain the concrete user-visible change. For a feature, describe the new capability; for a bug fix, describe the failure or limitation being fixed. If appropriate, include a small code example when it makes the issue clearer.
- Explain the approach used to implement the feature or fix the problem.
- Mention important caveats, follow-up work, performance notes, or test coverage when relevant.
Use backticks for code elements (function names, variables, file paths, etc.).
Line length
Ensure the maximum line length never exceeds 72 characters.
GitHub references
When referencing external GitHub PRs or issues, use proper GitHub interlinking format: "owner/repo#123"
Co-author trailer
If you wrote code yourself, include a co-author trailer at the end of
the commit message, e.g.:
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
(adjust the model name as appropriate).
However, when simply asked to write a commit message (without having written the code), there's no need to add that trailer.
Examples
The examples below are from real history; co-author trailers and PR numbers are omitted.
Feature addition
Reference: 5bb517f1a7698916b7ea8055fdd595feb5625c7f
type-definition: Implement `textDocument/typeDefinition`
Add server-side support for "Go to Type Definition". The handler runs
the `TypeAnnotation` pipeline (`get_inferrable_tree` →
`infer_toplevel_tree` → `get_type_for_range`) on the toplevel subtree
containing the cursor, then maps the inferred lattice element to a
concrete `Type` and returns the constructor method locations of that
type — falling back to the unwrapped wrapper for parametric types
(e.g. `Vector{Int}` → `Vector`) or to the parent module location when
no constructors are reachable. `Union` types fan out to one location
per constituent.
The feature is registered statically or dynamically based on the
client's `typeDefinition.dynamicRegistration` capability, and reports
back as `LocationLink[]` when `linkSupport` is advertised so the
origin selection range highlights only the cursor's identifier.
Bug fix
Reference: 3465a1caf98a615ad05d40eb5744c8efd4282926
diagnostic: Invalidate pull-diagnostic resultId on config changes
`compute_diagnostic_result_id` previously keyed the resultId only on
the file version (and dependency versions for files with explicit
imports). When `[diagnostic]` config changed, `handle_lsp_config_change!`
sent `workspace/diagnostic/refresh`, but the client's re-request with
the previous `previousResultId` matched the freshly-computed resultId
and the server returned `Unchanged`, so the refresh was effectively a
no-op and stale diagnostics persisted on the client.
Fold the current `DiagnosticConfig` value into the resultId so any
`[diagnostic]` config mutation flips the resultId and the refresh
takes effect.
Also defines `Base.hash(::DiagnosticConfig, ::UInt)` content-based.
`@option` from Configurations.jl generates `==` but not `hash`, so the
default `hash` fell back to `objectid` and broke the `==`/`hash`
contract — equal-valued `DiagnosticConfig` instances hashed
differently because of the embedded `patterns::Vector`. Without this,
the resultId fold above would spuriously invalidate the client cache
whenever `ConfigManagerData` was rebuilt with the same values.