diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 45c57a6f..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,51 +0,0 @@ -# Contributing - -> **Contributions are welcome!** Here's how you can help. :raised_hands: - -

-Content -· -Share -· -Something else -· -Additional notes -

- -## Content - -For additions, check that it hasn't been submitted already and that it is suitable for this list. - -1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) your fork. - -2. Start editing! - - **If you are adding a tool you are affiliated with please include other improvements/fixes to the repo.** - - Additions should be added to the bottom of the section. - - Please follow the [format](#format). - - 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. - -3. Commit & [push](https://help.github.com/articles/pushing-to-a-remote/) your changes to a new branch. - -4. Once you're happy with your changes, [create a pull request](https://help.github.com/articles/creating-a-pull-request/). - - If you're adding something new explain briefly why it's awesome. :sunglasses: - -## 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. - -## Something else - -Questions, feedback & ideas are all welcome - just [open an issue](https://github.com/cjbarber/ToolsOfTheTrade/issues)! :smile: - -Alternatively you can [contact the authors](https://github.com/cjbarber/ToolsOfTheTrade#authors). - -## Format - -Our format is currently: -``` -| [Example](https://example.com) | [@example](https://twitter.com/example) | pricing | slogan + description + tags | -``` diff --git a/contributing.md b/contributing.md new file mode 100644 index 00000000..da483d91 --- /dev/null +++ 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.