From 8662c7449491226553c4a8f0b38dd1671b6fc10c Mon Sep 17 00:00:00 2001 From: Sam Cross Date: Mon, 20 Jan 2020 12:37:12 +0000 Subject: [PATCH] feat: add Pull Request template (#459) * add pull_request_template.md * move and update pull_request_template.md --- .github/pull_request_template.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..dfbf5cb6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +# awesome-uses + +Please read the requirements corresponding to your pull request before you submit. + +## 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. + +## 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 + +## Final Requirements + +* You've read and understood the above + +**Add your name to verify:** Name \ No newline at end of file