Skip to content

Commit 57f7c91

Browse files
Merge pull request #153 from Yordaniss/doc-145-update-readme-file
added information about contribution and npm commands to readme file
2 parents 36d36b9 + 2145906 commit 57f7c91

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,23 @@ These people are sole backbone for this software. Want to get place in below hal
4747
<div align="center">
4848
Show some ❤️ by starring this awesome repository!
4949
</div>
50+
51+
# Getting started to contribute/use
52+
53+
1. Fork the repository from [Repository](https://github.com/jsvigneshkanna/tailwind_ui_components). Just click at `fork` icon to create a fork-repository in your GitHub. In your local machine clone the forked repository with command and go to your repository
54+
`git clone https://github.com/<username>/tailwind_ui_components.git`
55+
`cd tailwind_ui_components`
56+
2. After you choose the issue create new branch. (Use issue specifying either documentation, bug or feature than issue number and what should be done)
57+
`git checkout -b <branch_name> `
58+
3. Install dependencies
59+
`npm install`
60+
4. Run code locally
61+
`npm run dev`
62+
5. Go to `localhost:3000`
63+
6. Make the changes in code and test these. (nextJS and tailwind/plain CSS)
64+
7. After changes are ready, commit the changes:
65+
`git add <changed_file> `
66+
`git commit -m "commit message"`
67+
8. Push the changes to origin
68+
`git push origin <branch_name>`
69+
9. After that create new Pull Request in your GitHub account. (It should appeared after commits were pushed)

0 commit comments

Comments
 (0)