Adding a section for contribution guidelines.
What does this MR do?
When making an edit to a page, there is a link to contribution guidelines
however there are no guidelines in the linked file. This MR creates that section and will require guidelines to be laid out in this documentation. I am not sure what the guidelines should be, but I thought this could be a start to generate that discussion. Presumably it should link to the # Pajamas commit conventions Or that content should be merged here?
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 -
If embedding a Figma file, follow the Figma embed guide -
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
Links
Edited by Taurie Davis