Skip to Content

Contributing

Thanks for showing interest in contributing to Backyard UI, all your contributions are extremely valuable to the project ❤️


Need help?

Need help?

If you need further guidance, you can find our team on the following:

Ways to contribute

Ways to contribute

Report an issue

Report an issue

Found a website bug or React component issue? Open an issue on Github or #backyard on Slack. What if you have a question about something? Architecture, code, API, etc. Open a discussion

Propose a new component

Propose a new component

To get started, fill out the Backyard UI Submission Form and we’ll follow up with links and details for creating and submitting a component proposal.

Update a component or a design token

Update a component or a design token

To propose an improvement to an existing component or design token fill out the Backyard UI Submission Form.

Contributing workflow

Contributing workflow
  1. Decide how you want to contribute
  2. If you want to implement a new feature discuss it with the maintainer by Opening a discussion on Github or #backyard on Slack before jumping into code
  3. After finalizing issue details work on code. Please follow the commit convention
  4. Before submitting the PR, runs the yarn test and yarn lint
  5. Request a code review and fix all issues noticed by a maintainer
  6. If you cannot finish your task or change your mind - that’s fine, just let us know in the GitHub issue that you’ve created in the first step. We won’t judge or ask any questions if you decide to cancel your submission
  7. If everything is okay, your PR will be merged, you are awesome 🎉

Commit convention

Commit convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

Get started locally

Get started locally

The Backyard UI and the documentation are maintained on different repositories, so follow each self-guide to start: