Contributing

Contributions are welcome to the Pajamas UI Kit. Contributions include bug fixes, component usability improvements, or updating component instances.

Before You Start

  1. Check the issue tracker for an existing issue.
  2. If no issue exists, create a new issue using the Figma update template. This template provides a helpful checklist to guide your work.
  3. Refer to the component and breaking change guides while working.

Review requests

Requesting a branch review from a Figma maintainer is part of the Figma update template.

The review request description field is used to automatically generate release notes. Use comments to add additional context for reviewers and link to the related issue.

Description format rules

  • Start each line with a hyphen -.
  • Begin with one of these verbs: "Adds", "Enhances", "Changes", "Removes", "Fixes", or "Deprecates".
  • Be clear and concise.

Examples

Do:

- Adds multiple-choice icon

Don't:

- Hey can you take a look at this? I added a new icon

Multiple-line merge descriptions

Additional details can be added after the first line. Subsequent lines don't need to start with action verbs:

- Removes header property from Modal
- Header property is not optional in GitLab UI
- Updates instances to have realistic content

Last updated at: