Skip to content

good practices for commit messages #48

Open
@jelletreep

Description

@jelletreep
  • Capitalization and Punctuation: Capitalize the first word and do not end in punctuation. If using Conventional Commits, remember to use all lowercase.
  • Mood: Use imperative mood in the subject line. Example – Add fix for dark mode toggle state. Imperative mood gives the tone you are giving an order or request.
  • Type of Commit: Specify the type of commit. It is recommended and can be even more beneficial to have a consistent set of words to describe your changes. Example: Bugfix, Update, Refactor, Bump, and so on.
  • Length: The first line should ideally be no longer than 50 characters, and the body should be restricted to 72 characters.
  • Content: Be direct, try to eliminate filler words and phrases in these sentences (examples: though, maybe, I think, kind of). Think like a journalist.

Source

Activity

changed the title [-]Good practices for commit messages[/-] [+]good practices for commit messages[/+] on May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      good practices for commit messages · Issue #48 · UtrechtUniversity/workshop-computational-reproducibility