Contributing

Learn how to contribute to Shuriken UI.

Contribution guide

Thanks for taking the time to contribute to this project. In this guide you will find all the information you need to contribute to the Shuriken UI project.

About @shuriken-ui/nuxt

Shuriken UI Nuxt is the main part of the Shuriken UI project. Its goal is to provide a set of ready to use components to build apps with Nuxt using the Shuriken UI design system.

How to contribute

If you find a bug or want to add new features, makes sure to check if it has an impact on the Nuxt or the React versions of Shuriken UI. If it does, make sure to submit a PR to all the projects.

Also, note that we use the edge branch to develop new features. If you want to contribute, make sure to create a new branch from edge and to submit your pull request to the edge branch. (see Git conventions)

If you have any doubts or questions, feel free to open a discussion.

Setup the project

We use pnpm to manage our dependencies. Make sure to install it first.

corepack enable

@shuriken-ui/nuxt

Clone the project on your machine and install the required dependencies:

pnpm install

Now you can start the playground which is a basic Nuxt app using Shuriken UI Nuxt. You can use the playground to test your changes, or include any new component you've added to the package.

pnpm dev

Everything is ready, you can start coding! Don't forget to run the tests after your changes to make sure everything is working as expected.

pnpm test

Submitting your changes

Once you are done with your changes, you can submit a pull request, also known as a PR.

• Make sure the tests pass locally by running pnpm test, this will run the linter.
• Make sure to create a draft PR if it's not ready to be merged, see how to change stage of a PR
• Make sure to add a description of your changes, if relevant, add screenshots or gifs to illustrate your changes.
• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Shuriken UI maintainer will review your proposal. We may ask questions or request additional information.
• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

Git conventions

We use conventional commits to make our commits more readable and to generate our changelog.

Make sure to prefix your commit with one of the following types: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:

Use the imperative, present tense: “change” not “changed” nor “changes”.