Skip to content

Latest commit

 

History

History
111 lines (70 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

111 lines (70 loc) · 4.62 KB
Raw

Contributing to Radix Themes

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.

Heuristics

heuristic /ˌhjʊ(ə)ˈrɪstɪk/

A technique designed for solving a problem more quickly when classic methods are too slow, or for finding an approximate solution when classic methods fail to find any exact solution

  • Priority is the best User Experience
  • Complexity should be introduced when it’s inevitable
  • Code should be easy to reason about
  • Code should be easy to delete
  • Avoid abstracting too early
  • Avoid thinking too far in the future

Questions

If you have questions about Radix Themes, be sure to check out the docs where we have several examples and detailed API references that may help you solve your problem. You can also share your questions on GitHub Discussions.

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. You can answer questions on StackOverflow or GitHub Discussions, or provide solutions for others in open issues.
  • Write. If you come up with an interesting example, write about it. Post it to your blog and share it with us. We'd love to see what folks in the community build with Radix Themes!
  • Report. Create issues with bug reports so we can make Radix Themes 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 contributions 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>/themes.git
cd themes
git remote add upstream https://github.com/radix-ui/themes.git
  1. Synchronize your local main branch with the upstream remote:
git checkout main
git pull upstream main
  1. Make sure your Node version matches the .nvmrc.
node -v
  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

The repo is managed with pnpm Workspaces.

Development

# install dependencies
pnpm install

# start playground and see examples in the browser
pnpm dev

After staring the development server, navigate to http://localhost:3000/sink to view the playground. Visit other demos by navigating to pages in the app directory (./app/*), such as /demo, /explore-components, /home-os.

Make your changes and check that they resolve the problem with an example in /sink or another demo page. If there are no examples in the playground to support your change, we suggest adding one and then running local development to make sure nothing is broken.

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