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.

Sign up for GitHub

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

Jump to bottom

More details about commit messages in contributing.md #4598

Merged
merged 2 commits into from
Oct 8, 2024
Merged

More details about commit messages in contributing.md #4598

merged 2 commits into from
Oct 8, 2024

Commits on Oct 7, 2024

  1. docs: clarify that commit messages start with a topic, not a component 

    It's generally more useful to say something like "revset: use Self to
refer to expressions of the same type" than "lib: use Self to refer to
revset expressions of the same type ", so let's try to clarify that.
    @martinvonz
    martinvonz committed Oct 7, 2024
    Configuration menu
    Copy the full SHA
    c543ab3 View commit details
    Browse the repository at this point in the history

  2. docs: explain a bit about good commit messages 

    We didn't have any guidelines about what to include in a commit
message. Others have already written good guides for that. This commit
adds a link to one. I also added a sentence about explaining the
reason for a change, since I think that's particularly often missed
(I'm sure I also miss it sometimes - don't hesitate to point out when
that happens).
    @martinvonz
    martinvonz committed Oct 7, 2024
    Configuration menu
    Copy the full SHA
    149092f View commit details
    Browse the repository at this point in the history