Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 3.66 KB
Raw

Contributing

We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Using the issue tracker

The issue tracker is the preferred channel for bug reports and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.
  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Bug reports

A bug is a demonstrable and reproducible problem that is caused by the code in the repository. Good bug reports are extremely helpful to the project, so thanks!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce the bug using the latest main branch in the repository. The latest npm release, isn't always the representative version of the code.

  3. Isolate the problem — ideally create a isolated example, using a 'vanilla' configuration of your chosen framework. CodeSandbox and StackBlitz offer an easy way to do this.

Use our issue template to help you report bugs, if you're confident the bug is still valid.

Pull requests

Good pull requests are a fantastic help. They should remain focused in scope and avoid containing code and commits unrelated to the problem or feature you're adding.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Updating Primer Brand

  1. Clone this repository.
  2. Create a new feature branch: git checkout -b my-handle/my-branch-name.
  3. Configure and install the dependencies: npm install
  4. Make your changes and commit them.
  5. Create a changeset for your changes if your contribution affects distributed code: npx changeset
  6. Push your branch and open a pull request. Please use the supplied pull request template.
  7. Wait for CI tests to complete.
    • If the tests pass, you should see a status check advising you that a canary build of @primer/react-brand has been published, and ready to test in-app.
    • If the tests fail, review the logs and address any issues.
    • If the builds fail for any other reason (as they occasionally do), they may need to be manually restarted.
  8. Pat yourself on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Releasing a new Primer Brand version

See RELEASING.md for our release process.

Resources