Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 3.99 KB

Contributing to Shuriken UI - Tailwind

Thanks for taking the time to contribute! 🎉

In this guide you will find all the information you need to contribute to the project.

What is Shuriken UI Tailwind?

Shuriken UI Tailwind is main part of the Shuriken UI project by Css Ninja. It goal is to provide a set of Tailwind CSS components, to be framework agnostic and highly customizable.

  graph TD;
      A("@shuriken-ui/tailwind")-->B("@shuriken-ui/nuxt");
      A("@shuriken-ui/tailwind")-.->C(...);
      A("@shuriken-ui/tailwind")-->D("@shuriken-ui/next");
Loading

New contributor guide

This package provide a Tailwind CSS preset which contains all the components and utilities. It also extend the default theme with some colors and fonts.

All the components are separated in their own Tailwind CSS plugin and can be configured in the tailwind.config.ts file, so you can easily customize each component.

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

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

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

Setup the project

We haven't published the test project yet. For now, you can follow the steps described in the Shuriken UI Nuxt project to tests your changes in the playground.

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”.

gitGraph
  commit
  commit tag: "vX.X.X"
  branch release/next
  commit
  branch feat/your-feature
  commit id: "feat(BaseButton): what you added"
  commit id: "refactor(BaseButton): clean up props"
  checkout release/next
  commit
  merge feat/your-feature
  commit tag: "vX.X.X-beta.x"
Loading