Merge pull request #21 from VirginieLemaire/add_CONTRIBUTING

Added contributing guide

Author: jsvigneshkanna

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing guide
+
+Thank you for investing your time in contributing to this project!
+Please follow this steps :smiley:
+
+## 1. Issues
+
+### Check if an issue exists
+
+If you spot a problem, please [search if an issue already exists](https://github.com/jsvigneshkanna/tailwind_ui_components/issues). If nobody is assigned to this issue, comment the issue to get assigned from maintainers.
+
+### Create a new issue
+
+If it doesn't, you can open a new issue using the [new issue form](https://github.com/jsvigneshkanna/tailwind_ui_components/issues/new/choose) specifying if it's about a bug, a feature, documentation or anything else.
+
+
+## 2. Fork this repository
+
+Once assigned to an issue, you can fork this repo.
+
+<details>
+<summary>Show me how to fork a repository</summary>
+Click the **Fork** button on the top right of this repository page
+
+![screenshot of Fork button](https://docs.github.com/assets/cb-23088/images/help/repository/fork_button.png)
+
+It will create a copy of this repository into your account. 
+
+Select the owner for the forked repository
+![GitHub example](https://docs.github.com/assets/cb-151543/images/help/repository/fork-choose-owner.png)
+
+Choose to **copy only the master branch** and click **Create fork**
+</details>
+
+
+## 3. Clone the fork
+
+Go to your fork repository and clone : 
+1. `git clone [your repo url goes here]`
+2. change directory to your cloned repo `cd [your repo name]`
+
+## 4. Create a new branch and code
+
+**Don't code on the master branch**
+
+Run `git checkout -b [your branch name goes here]` to create your new branch
+
+Make your edits with you favorite IDE
+
+## 5. Save and push
+
+Run `git add .`
+
+Run `git commit -m 'Commit message goes here'` :warning: please commit with an descriptive message for the convenience of reviewer
+
+Finally, run `git push origin [your branch name goes here]`
+
+## 6. Create a pull request (PR)
+
+- Go to your repository in browser and click on compare and pull requests. 
+- Then add a suitable and crisp title and description to your pull request that explains your contribution.
+- Follow the PR template without compromising anything.
+- Mention anyone of the reviewers (jsvigneshkanna)
+- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳
+
+## 7. Star this repo
+
+Please star this repo to make this project cooler
+
+Happy contributing !

README.md

@@ -9,7 +9,7 @@ free resources to learn or play with these utility based classes
 If you are searching for an answer for above question/ rant, then this website is best suitable for you all. Here we can get almost all layouts and components built under Tailwind CSS, and the best part is we can play around them in inbuilt code editor and copy the codebase too for your projects
 
 # Like to contribute us by code/ design
-Please follow the contributing guide for this repo. Anything that is not followed will not be entertained as contribution.
+Please follow the [contributing guide](./CONTRIBUTING.md) for this repo. Anything that is not followed will not be entertained as contribution.
 
 # Like to contribute us by money
 This contribution is not forced but welcomed, as this will help us run this software for long time