Skip to content

Elaborate on Git commit guidelines #218

@NVedsted

Description

@NVedsted

The session plan does not elaborate on how a commit message should be constructed. This can be subjective so it makes sense to some extent, however, I would suggest at least adding some general guidelines.

E.g., some simple guidelines could look something like this:

  1. Be consistent.
  2. Spent the extra effort; you will thank yourself in the future.
  3. Write in an imperative mood.
  4. Describe the "why" and not the "what".
  5. Leave out information that is already present in the commit. (File names, whether you created/updated, etc.)

Veronika Burduzhan also suggested on Slack to use Conventional Commits. While I personally believe it could be a bit overkill during the Git introduction, it could also be presented as an alternative.

@siderdk mentioned the following guidelines:

  1. Keep them concise and descriptive
  2. Learn about different conventions
  3. Choose one style and stay consistent

These are also good, simple, and generally unopinionated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions