Improve contributing

This commit is contained in:
Nikita Voloboev 2017-12-18 02:33:01 +01:00
parent 9f1b8d2bec
commit 1db9d5cbaf
No known key found for this signature in database
GPG Key ID: 43EDACFC00099A17
2 changed files with 22 additions and 20 deletions

View File

@ -1,12 +1,14 @@
# Contribution Guidelines
Ensure your pull request adheres to the following guidelines:
- Search included books before adding a new one, as yours may be a duplicate.
- Every book addition should follow the same format.
1. The book should be put into its appropriate category (Pick the one you think is closest if you are not sure).
2. If the book is free, link to the free book. If the book is not free, link to the book on [Goodreads.com](https://www.goodreads.com/)
3. Add appropriate emoji. If the book is free add 📖 before the name. If it is not, add 📕.
- Use the following format: `<emoji> [Book name](link) - Description.`
- If the book is free link to the free book and add 📖 emoji.
- If the book is not free, link to the book on [Goodreads.com](https://www.goodreads.com/) and add 📕 emoji.
- The book should be put into its appropriate category (Pick the one you think is closest if you are not sure).
- If you want to add a link to notes for the book, add it below the book as subdashed point.
- Please add a short description of the book after the book name where it is appropriate.
- Start the description with a capital and end with a full stop/period.
- Don't start the description with `A` or `An`.
- New categories or improvements to the existing categorisation are welcome.
- Check your spelling and grammar.
- You can also add other related websites and repositories in the end.

View File

@ -699,7 +699,7 @@ The subdashes after the book may include notes and other useful material related
- [📕 How linux works (2014)](http://www.goodreads.com/book/show/514432.How_Linux_Works)
### iOS
- [iOS 10 programming fundamentals with swift (2015) 📕](http://shop.oreilly.com/product/0636920055211.do)
- [📕 iOS 10 programming fundamentals with swift (2015)](http://shop.oreilly.com/product/0636920055211.do)
## Memoirs
- [📕 Walden (1854)](http://www.goodreads.com/book/show/16902.Walden)