From 5ebc2a6398a5c81a38ec32a58fdeb89bd68ad958 Mon Sep 17 00:00:00 2001 From: Morgan Date: Wed, 12 Sep 2018 03:58:21 +0200 Subject: [PATCH] add contribution guidelines --- CONTRIBUTING.md | 14 ++++++++++++++ README.md | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..78efaf2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contribution Guidelines + +To start a discussion, simply create an issue. + +You can add links through pull requests, ensure your pull request adheres to the following guidelines: + +- Search previous suggestions before making a new one, as yours may be a duplicate. +- Make an individual pull request for each suggestion. +- Use the following format: + - for GitHub repos : `[author/reponame](link) - Description.` `. + - for websites : `[Website](link) [language] - Description.` `[language]` is optional if english. + - for articles : `[Author](link) [language] - (publication year) Description.` `[language]` is optional if english. +- Keep link descriptions short and simple, but descriptive. +- Check your spelling and grammar. diff --git a/README.md b/README.md index 6e74ded..e0fa015 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ - I spend a lot of time on internet, losing myself in lot of topics. I choose GitHub to list my findings and bookmarks in a central location for productivity, to avoid losing my findings, and also to share them with the world. - :warning: [**Full version**](https://github.com/MorganGeek/bookmarks/blob/master/README.md) :warning: I advise you to consult this very same page [here](https://github.com/MorganGeek/bookmarks/blob/master/README.md) for full content, as [GitHub truncates files with a size over 500KB on main page](https://twitter.com/MorganGeek/status/976936079025737729), causing incomplete display of this list. -Contributions are more than welcome. Add links through pull requests or create an issue to start a discussion. +Contributions are more than welcome. Read the [contribution guidelines](CONTRIBUTING.md). by **[@MorganGeek](https://twitter.com/MorganGeek)**