Skip to content

Latest commit

 

History

History
128 lines (87 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

128 lines (87 loc) · 3.87 KB
Raw

For the contributors 🫂

Haven't made your first-contribution yet? 😢

Do check our First Contribution repository, where we have provided the guidelines to set up Git and how to make a pull request !

Table of Content

How to contribute?

Raise an issue and build a component you want to build.

FAQ

Project setup in local

Project setup for website-dev branch

How to contribute? ( You must use tailwind CSS )

Using Tailwind playground.

One can easily make a contribution to this repository without setting it up locally. If you are building a new UI component, then follow the steps written below.

Step 1:

  Go to Tailwind Playground.

Step 2:

  Build the UI component using HTML and Tailwind CSS.

Step 3:

  Add your code to the mentioned path and make a new PR.

PR guide:

  You need to make a PR with the template mentioned below.

Here is the component I have built. 

Here is a screenshot of that.

### Add a screenshot here

If you are solving any other issue, make your own PR. don't need to follow this template.

Raise an issue and build a component you want to build.

  • Navigate to the SeamLess UI repository on GitHub.
  • Click on the "Issues" tab.
  • Click on the "New issue" button. New Issue Badge
  • Then create an issue using the New Component issue template.
  • Provide a descriptive title for the issue.
  • Take a screenshot of the component you want to build from the figma file, and paste it in the issue description. Make sure the component is not already built.
  • Get assigned and build it.

This is super easy. 👍

FAQ

Question Answer
1. What to do for local images? You can upload the image online like this and use the image link.
2. Does tailwind playground is enough to build any component ? Yes, absolutely.
3. How to test responsiveness in tailwind playground? Tailwind play ground have a responsive mode where you can test it. You can find that option on the top right corner
4. What are the pre-requisite to contribute? Basic HTML and Tailwind CSS knowledge will be enough for contribution and making the components.

Project setup in local

Fork and clone the repository

git clone https://github.com/Clueless-Community/seamless-ui.git

Change the directory

cd seamless-ui

Once you are done with the changes, follow the steps to make the pull request.

Create and checkout to the new branch.

git checkout -b <branch_name>

Add the changes

git add .

Commit your change with a proper message

git commit -m "Enter your message here"

Make the Pull Request

git push origin <branch_name>

Project setup for website-dev branch

To make any changes in the website, you have to push your code to website-dev branch only.

After Forking > Cloning > Change branch to website-dev

git checkout website-dev

To install all the dependencies

pnpm i

To start the dev server

pnpm run dev