Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (51 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

82 lines (51 loc) · 2.96 KB
Raw

Contributing to the Radix Website

Code of Conduct

Radix has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it.

Please read the full text so that you can understand what actions will and will not be tolerated.

How to contribute

There are many ways to contribute to the project. Code is just one possible means of contribution.

  • Feedback. Tell us what we're doing well or where we can improve.
  • Support. Provide solutions for others in open issues.
  • Report. Create issues with bug reports so we can make our website even better.

Working on your first Pull Request?

There are a lot of great resources on creating a good pull request. We've included a few below, but don't be shy—we appreciate all contriibutions and are happy to help those who are willing to help us!

Preparing a Pull Request

Pull Requests are always welcome, but before working on a large change, it is best to open an issue first to discuss it with maintainers.

A good PR is small, focuses on a single feature or improvement, and clearly communicates the problem it solves. Try not to include more than one issue in a single PR. It's much easier for us to review multiple small pull requests than one that is large and unwieldy.

  1. Fork the repository.

  2. Clone the fork to your local machine and add upstream remote:

git clone https://github.com/<your username>/website.git
cd website
git remote add upstream https://github.com/radix-ui/website.git
  1. Synchronize your local main branch with the upstream remote:
git checkout main
git pull upstream main
  1. Install dependencies with pnpm:
pnpm install
  1. Create a new branch related to your PR:
git checkout -b my-bug-fix
  1. Make changes, then commit and push to your forked repository:
git push -u origin HEAD

  1. Go to the repository and make a Pull Request.

  2. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.

Working locally

Development

# install dependencies
pnpm install

# start the local server and see the site in your browser
pnpm dev

Make your changes and check that they resolve the problem as expected.

Finally, run pnpm build to ensure that the build runs successfully before submitting the pull request.