docs(commits): Clarify how to write a commit
What does this MR do?
Simplifies the example of how to write a commit. The blank lines were confusing and indicates that the description and footer are optional
Does this MR meet the acceptance criteria?
-
The MR title and commit message meet the Pajamas commit conventions -
Add a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what -
Include MR scope that reflects the purpose of the change in the description - For example, if this MR is focused on
usage guidelines
, addressingaccessibility challenges
could be added separately with a different MR
- For example, if this MR is focused on
- [-] If creating a new page on Pajamas from scratch, follow the page template structure
- [-] Follow the Pajamas Voice & Tone Guidelines and GitLab Documentation Style Guide
- [-] Link components to and from other related components and patterns on the
.md
file, where helpful -
Assign it to a reviewer. All GitLab designers are reviewers, but you can also assign it directly to a maintainer or trainee maintainer - [-] Apply the correct component label(s)
-
Select a milestone or due date