docs: move contributing details to CONTRIBUTING doc

sortxyz · Jul 7, 2023 · a115ab1 · a115ab1
1 parent 8a8a96f
commit a115ab1
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 36 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -60,10 +60,37 @@ this step easier.
 
 3. Create a working branch and start with your changes!
 
-### Commit your update
+#### Test your change
 
-Commit the changes once you are happy with them. Review your changes yourself
-before opening a pull request to speed up the review process :zap:.
+Test your changes before committing them.
+
+##### Run a local build
+
+```bash
+npm run build
+```
+
+##### Link the package
+
+```bash
+# do this in this repo
+npm run link
+```
+
+##### Link the package in your project
+
+```bash
+# do this in your project
+npm run link @sort/react-components
+```
+
+#### Prepare for release
+
+If everything works as expected, go ahead and make the commit.
+
+#### How to write commits
+
+We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), if you're not familiar with it, please take a look as it will determine the type of release that is created.
 
 ### Pull Request
 
@@ -87,5 +114,5 @@ merge conflicts and other issues.
 
 ### Your PR is merged!
 
-Congratulations :tada::tada: You are now part of the Sort develop community. The
+Congratulations :tada::tada: You are now part of the Sort development community. The
 Sort team thanks you :sparkles:.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # [sort.xyz](https://sort.xyz) react components
 
 > 🧪 This project is currently in ALPHA which means you can expect bugs and API
-> changes.  
+> changes.
 > Feedback? Let us know by [opening an issue](https://github.com/sortxyz/react-components/issues).
 
 ---
@@ -100,34 +100,4 @@ vulnerabilities.
 
 ## Contributing
 
-
-### Test your change
-
-#### Run a local build
-
-```bash
-npm run build
-```
-
-#### Link the package
-
-```bash
-# do this in this repo
-npm run link
-```
-
-#### Link the package in your project
-
-```bash
-# do this in your project
-npm run link @sort/react-components
-```
-
-### Prepare for release
-
-if everything works as expected, go ahead and make the commit
-
-
-#### How to write commits
-
-We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), if you're not familiar with it, please take a look as it will determine the type of release that is created.
+See [CONTRIBUTING](./CONTRIBUTING.md)