Contributing to Chakra UI

Thanks for showing interest to contribute to Chakra UI 💖, you rock!

When it comes to open source, there are different ways you can contribute, all of which are valuable. Here's a few guidelines that should help you as you prepare your contribution.

Here's the table of contents:

Setup the Project
- Commands
Updating the docs for new release
Proposing new or changed API?
Making a Pull Request?
- Commit Convention
- Steps to PR
Want to write a blog post or tutorial
Want to help improve the docs?
License

Setup the Project#

Setting up the docsite project is easy. It's a Next JS site. The following steps will get you up and running to contribute to the Chakra UI docsite:

Fork the repo (click the Fork button at the top right of this page)
Clone your fork locally

git clone https://github.com/<your_github_username>/chakra-ui-docs.git
cd chakra-ui-docs

Setup all the dependencies and packages by running yarn.
Execute yarn dev to spin up a local development server. If you're running Windows, contentlayer might not work as expected, so you'd need to do npx contentlayer build before running yarn dev in order to generate the docsite content.

If you run into any issues, kindly reach out to the Chakra UI React team here: https://discord.gg/chakra-ui

Commands#

yarn: installs the dependency packages.

yarn dev: starts the local development server.

yarn build: builds the docsite for production.

yarn lint: runs the nextjs linter which checks for code issues.

yarn avatars:gen: regenerates the avatars

yarn members:gen: regenerates the members

yarn search-meta:gen: regenerates the search meta

yarn showcase-data:gen: regenerates the showcase data

yarn changelog:gen: regenerates the Changelog

yarn cache:clean: deletes the .contentlayer folder

yarn clean: deletes the yarn.lock file and node_modules

Updating the docs for new release#

When a new version of @chakra-ui/react has been released, here's what you need to do to get it reflected in the docs:

Bump the version of @chakra-ui/react
Run yarn changelog:gen to fetch the most recent changelog from the main repository
Open a Pull Request titled docs: updates for new release

Commit Convention#

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

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

feat: all changes that introduce completely new code or new features
fix: changes that fix a bug (ideally you will additionally reference an issue if present)
refactor: any code related change that is not a fix nor a feature
docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
test: all changes regarding tests (adding new tests or changing existing ones)
ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
chore: all changes to the repository that do not fit into any of the above categories

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Steps to PR#

Fork of the chakra-ui-docs repository and clone your fork
Create a new branch out of the main branch. We follow the convention [type/scope]. For example fix/accordion-hook or docs/menu-typo. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.
Make and commit your changes following the commit convention. As you develop, you can run yarn lint and yarn lint to make sure everything works as expected. Please note that you might have to run yarn first in order to install all dependencies.

Want to write a blog post or tutorial#

That would be amazing! Reach out to the core team here: https://discord.gg/chakra-ui. We would love to support you any way we can.

Want to help improve the docs?#

By default, the GitHub REST API has an anonymous user rate limit. This can be hit during heavy local docs development if the server is frequently restarted.

Creating a GitHub token and storing it as the GITHUB_TOKEN environment variable allows the user to avoid the limit.

Visit https://github.com/settings/tokens/new?description=Chakra+website+development to create a new personal access token. After creating the token, be sure to copy the token string to your clipboard.

You'll then run the following command in the terminal that you'll start the docs from:

export GITHUB_TOKEN=<PASTE YOUR TOKEN HERE>

License#

By contributing your code to the chakra-ui-docs GitHub repository, you agree to license your contribution under the MIT license.