Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Place for issue reference in commit message #28

Closed
roman-khimov opened this issue Jul 29, 2024 · 3 comments
Closed

Place for issue reference in commit message #28

roman-khimov opened this issue Jul 29, 2024 · 3 comments
Labels
bug Something isn't working discussion Open discussion of some problem I3 Minimal impact S4 Routine U4 Nothing urgent

Comments

@roman-khimov
Copy link
Member

Current Behavior

Commit message guideline can be read as allowing header: short message, fix №XYZ or not
nspcc-dev/neo-go#3526 (comment)

Expected Behavior

Some explicit specification.

Possible Solution

Decide on whether it's allowed and document it.

@roman-khimov roman-khimov added U4 Nothing urgent bug Something isn't working S4 Routine I3 Minimal impact labels Jul 29, 2024
@carpawell
Copy link
Member

I would always place it in the body. No strict pros. Header says about the "code" thing to me, while body explains with some additional context (external refs).

@roman-khimov
Copy link
Member Author

To me it's perfectly fine if it fits. Less lines, less things to think about.

@AnnaShaleva
Copy link
Member

AnnaShaleva commented Aug 5, 2024

It's OK to me to use both ways. However, my personal preference matches @carpawell's opinion: use header for text description only, use body for links. It just looks more pretty to me, but it's an extremely subjective argument.

UPD: sometimes I need to put several links to PRs in the commit message, and sometimes I need to put a commit hash. Sometimes these additional links does not fit into header, and thus I put them into commit body. I love unification, and that's why I just always put all links to the commit body.

@AnnaShaleva AnnaShaleva added the discussion Open discussion of some problem label Aug 5, 2024
roman-khimov added a commit that referenced this issue Sep 10, 2024
git: explicitly say that it's OK to fix #28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working discussion Open discussion of some problem I3 Minimal impact S4 Routine U4 Nothing urgent
Projects
None yet
Development

No branches or pull requests

3 participants