Thanks for being interested in contributing! We're so glad you want to help!
We want contributing to Chakra UI Vue to be enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs, as well as updates and tweaks, blog posts, workshops, and more.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Please create a new branch from an up to date master on your fork. (Note, urgent hotfixes should be branched off the latest stable release rather than master)
git clone firstname.lastname@example.org:<yourname>/chakra-ui-vue.git
git checkout -b my-feature-branch
git push --set-upstream origin my-feature-branch.
If you have an existing local repository, please update it before you start, to minimise the chance of merge conflicts.
git remote add upstream email@example.com:chakra-ui/chakra-ui-vue.git git checkout master git pull upstream master git checkout -b my-feature-branch
Chakra UI uses NuxtJS for its documentation website. Thank you in advance and cheers for contributing to our documentation! We created a simple command to run it.
You can now access the documentation site locally. Changes to the docs will hot reload the site.
yarn bootstrap # Installs all dependencies and links packages yarn dev # Runs dev build yarn storybook # Starts storybook yarn test # Runs tests
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
Examples of unacceptable behavior by participants include:
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!