Skip to content

Latest commit

 

History

History
149 lines (110 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

149 lines (110 loc) · 4.38 KB
Raw

Contributing

Thank you for your interest in contributing to tailus-ui-react. We are delighted to have you here.

Before submitting your first pull request, please take a moment to review this document. We also strongly recommend checking for open issues and pull requests to see if someone else is working on something similar.

If you need any help, feel free to reach out to @tailus-ui.

About this repository

This repository is the source code for the React components of Tailus UI.

  • We use npm as our package manager.
  • We use React for the website and components.
  • We use Radix for the components.
  • The styles applied to the components come from Tailus Themer.
  • vite is used for the development server.
  • Prettier is used for code formatting.
  • ESLint is used for linting.
  • Tailwind CSS is used for styling the components.
  • Storybook is used for testing the components.
  • The project is based on TypeScript.

Structure

This repository is structured as follows:

public
src
├── components
├   └── ...
├── lib
├   └── ...
.eslintrc.cjs
.gitignore
.prettierrc.cjs
LICENSE.md
package.json
package-lock.json
ostcss.config.js
prettier.config.cjs
README.md
tailwind.config.cjs
tsconfig.json
vite.config.cjs
...


| Path                  | Description                               |
|-----------------------|-------------------------------------------|
| `public/`             | Contains the static files for the website.|
| `src/components`      | Contains the components.                  |
| `src/lib/`            | Contains the library files.               |

Development

Fork this repo

To create a fork of this repository, simply click on the "Fork" button located in the top right corner of this page.

Clone on your local machine

git clone https://github.com/your-username/tailus-ui-react.git

Navigate to project directory

cd tailus-ui-react

Create a new Branch

git checkout -b my-new-branch

Install dependencies

npm install

Run Storybook

To start the development process, run the following command:

npm run storybook

Components

Our components are located in the src/components directory. Each component has its own directory. For example:

src
└── components
    └── ...

When adding or modifying components, please ensure that:

  1. You can make the changes for every style.
  2. You can add tests for the component.
  3. You can add documentation for the component.
  4. You can also suggest improvements

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 / feature: 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 (or additions) concerning the continuous integration configuration (i.e. github actions, ci system)

  • chore: all changes to the repository that do not fit into any of the above categories

    e.g. feat(components): add new prop to the avatar component

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

Requests for new components

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.