Update contributing

mmulji · Sep 21, 2018 · 174beea · 174beea
1 parent 3ad8c68
commit 174beea
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 51 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1,23 @@
+# Contributing
+
+**If you are adding a tool you are affiliated with please include other improvements/fixes to the repo.**
+
+If you're adding something new, make sure that it is [formatted correctly](#list-format) and be sure to explain why it is awesome. 😎
+
+* Ideally the tool should be hosted, however self-hosted tools are acceptable too.
+* The product/service should have had some coverage on Hacker News - whether this be comments or posts.
+* Descriptions should be concise, descriptive and not marketing-focused.
+* Avoid links appended with `/en`, `gb` etc. so that the link will redirect to the user's own language/location.
+
+## List Format
+
+```
+| [Example](https://example.com) | [@example](https://twitter.com/example) | Free or $5/user/mo | An example tool used for example purposes `Tag` |
+```
+
+Tags can be either `Hosted` or `Self-hosted`, helpful for searching the list.
+
+## Share
+
+- Star this repo to help ensure it is maintained.
+- [Tweet this repo](https://twitter.com/intent/tweet?related=chrisbarber&text=Hacker%20News%20Tools%20of%20The%20Trade&url=https%3A%2F%2Fgithub.com%2Fcjbarber%2FToolsOfTheTrade&via=chrisbarber) so that more people can discover and add to it.