-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Description
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:
- Be consistent.
- Spent the extra effort; you will thank yourself in the future.
- Write in an imperative mood.
- Describe the "why" and not the "what".
- 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:
- Keep them concise and descriptive
- Learn about different conventions
- Choose one style and stay consistent
These are also good, simple, and generally unopinionated.
adamblanchard
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Backlog