From 880c4639058f6063b9effc9378ed911cd01440f0 Mon Sep 17 00:00:00 2001
From: Blake Campbell <blakecampbell.dev@gmail.com>
Date: Sat, 18 Dec 2021 16:21:01 -0500
Subject: [PATCH] Adding contribution guide

---
 contiribution-guide.md     | 39 ++++++++++++++++++++++++++++++++++++++
 scripts/readme-template.md |  1 +
 2 files changed, 40 insertions(+)
 create mode 100644 contiribution-guide.md

diff --git a/contiribution-guide.md b/contiribution-guide.md
new file mode 100644
index 00000000..e947d890
--- /dev/null
+++ b/contiribution-guide.md
@@ -0,0 +1,39 @@
+# Contributions to uses.dev
+
+## Steps
+1) Fork this repo
+2) Add yourself to `/src/data.js`
+3) When requesting a PR please read carefully.
+4) Be nice to maintainers
+
+## PR Guidelines
+- Should be updated with the latest main or master branch.
+- PR Title should be the name or handle of the person being added or update being made.
+  - A bad PR title `update data.js`
+  - A goob PR Title `Adding Blake Campbell`
+
+## What's a Uses Page?
+
+A /uses page lists a developer's setup, gear, software, and configs (what they *use*). It's a great reference for those looking to add to their library of tools or reconfigure ones they already use.
+
+### What Should I Include?
+
+Include the hardware you use, such as your computer and other related equipment. Include your preferred terminal, text editors, tools, frameworks, and other related software you use. If you can, include configurations for software (such as fonts and themes). The more you have on your /uses page, the more interesting it'll be to those who view it - just keep it on-topic!
+
+## Adding Yourself
+
+* Ensure you are linking to a /uses page, **not just your website**
+* Ensure your data is formatted like other entries
+* Do not add yourself to the end of the array (add yourself somewhere random instead)
+* Ensure this PR has a title in the following format
+    * ✅ Add Your Name
+    * ✅ Add @twitterusername
+    * ❌ Add myself
+    * ❌ Adding myself!
+    * ❌ Add Your Name @twitter @github
+
+## Code Modifications
+
+* Ensure the code submitted is formatted similarly to existing code
+* Ensure variable, method, function, and component names are clear and concise
+
diff --git a/scripts/readme-template.md b/scripts/readme-template.md
index e6087f72..a66d2eff 100644
--- a/scripts/readme-template.md
+++ b/scripts/readme-template.md
@@ -1,5 +1,6 @@
 # → Visit [uses.tech](https://uses.tech) for a good time
 
+## Please read [Contribution Guide](./../contiribution-guide.md) before submitting a PR.
 A list of `/uses` pages detailing developer setups, gear, software and configs.
 
 Add your own `/uses` page in [data.js](https://github.com/wesbos/awesome-uses/blob/master/src/data.js).