We're thrilled that you want to contribute to primer/figma. Your help is essential for keeping it great.
If you need support with your contribution, please create a contribution issue or reach out via #primer-figma (internal).
This repository contains the following Figma libraries:
If you find a bug in any of the libraries that are part of primer/figma please create a detailed bug report.
Guidelines for bug reports:
-
Use the issue search to check if the issue has already been reported.
-
Check that you have updated to the latest Figma library release.
-
Use our issue template to help you report bugs
Good contributions are a fantastic help. Make sure to keep pull requests focused in scope and avoid changes unrelated to the problem or component you're adding.
If you want to change or add multiple things, create multiple branches to send multiple pull requests.
Please create an issue discussing your intended change before embarking on any significant pull request (e.g., adding a new component or changing existing components in significant ways); otherwise, you risk spending a lot of time working on something that we might not be able to merge into the libraries.
Guidelines for contributions:
-
If it's a bigger change, create an issue to discuss it first
-
Create a new branch in figma
-
Make your changes in the new branch
-
Make sure your changes fulfil the requirements from the checklist
-
If you created an issue, add a comment mentioning that the PR is ready for review.
-
Assign the DRI from the table below to review and merge your branch
| Internal Figma library | External Figma library | DRI |
|---|---|---|
| Primer Web (Internal) | Primer Web (External) | @lukasoppermann |
| Primer Brand (Internal) | @danielguillan |
- Changes to the component API (props, variants, etc.) are reflected in the documentation sheet
- Properties are sorted in sensible order
- When adding a component the default variant is used
- Changes are accessible
- Properties and behavior is as close to code as possible
- All layers are named and don't use defaults (e.g. no
Frame 23)
- Component name matches the name used for the code component but uses
PascalCase(see "Spelling of component names") - Component is added to the overview page
- Component is in light mode
- Component uses primitives by using styles from
Primer PrimitivesFigma library - Properties are designed according to property guidelines
- The component adheres to the authoring components guidelines