Skip to content

CONTRIBUTING.md: pretty.fixes git config is confusing #2394

Open
@dseomn

Description

@dseomn

This section of CONTRIBUTING.md looks like it's mixing two separate things, the way to reference a bug that will be fixed by a commit, and the way to reference a commit:

common/CONTRIBUTING.md

Lines 163 to 166 in 954a8ce

[core]
abbrev = 12
[pretty]
fixes = Fixes: %h (\"%s\")

Is there any reason to use a git pretty format for Fixes:?

Using a config like that does make sense for referencing a commit. There is a very similar format already built into git though, --pretty=reference:

$ git show --pretty=reference --abbrev=12 --no-patch ebbd38fd7111a0299c30234dc6d0fcb9329a69f6
ebbd38fd7111 (ci: switch to golangci-lint v2.0, 2025-03-25)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions