add contribution guidelines
This commit is contained in:
parent
f3c40fbeb2
commit
5ebc2a6398
14
CONTRIBUTING.md
Normal file
14
CONTRIBUTING.md
Normal file
@ -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.
|
@ -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.
|
- 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.
|
- :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)**
|
by **[@MorganGeek](https://twitter.com/MorganGeek)**
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user