2020-06-24 06:51:49 +06:00
|
|
|
# Contributing
|
2018-09-10 23:38:10 +06:00
|
|
|
|
2020-06-24 06:51:49 +06:00
|
|
|
Thank you for taking the time to contribute! ♥️ Ensure your PR adheres to following guidelines:
|
2018-09-10 23:38:10 +06:00
|
|
|
|
2017-12-11 07:28:39 +06:00
|
|
|
- Search included books before adding a new one, as yours may be a duplicate.
|
2019-11-05 20:59:08 +06:00
|
|
|
- Only add books you think are great! Feel welcome to remove entries that you think aren't great!
|
2019-11-05 21:17:14 +06:00
|
|
|
- Use the following format: `[<📕 or 📖> Name (Year)](link) - Description.`
|
2018-01-18 20:25:46 +06:00
|
|
|
- If you can't find the year the book was written in, you can skip adding the year.
|
2018-01-18 20:16:02 +06:00
|
|
|
- If the book is free, link to the free book and add 📖 emoji.
|
2018-01-18 20:14:19 +06:00
|
|
|
- If the book is not free, link to the book on [goodreads.com](https://www.goodreads.com/) and add 📕 emoji.
|
2019-11-05 20:59:08 +06:00
|
|
|
- The book should be put into its appropriate category. Pick one you think is closest if you are not sure.
|
2018-06-29 19:58:00 +06:00
|
|
|
- Sort the books inside a category from most recent to oldest.
|
2019-11-05 20:59:08 +06:00
|
|
|
- If you want to add a link to notes for the book, add it to Description inbetween `()`. i.e. `(Notes[link])`
|
2018-01-18 20:14:19 +06:00
|
|
|
- Start the description with a capital and end with a full stop.
|
2017-12-18 07:33:01 +06:00
|
|
|
- Don't start the description with `A` or `An`.
|
2017-12-15 17:01:43 +06:00
|
|
|
- Check your spelling and grammar.
|
2019-11-05 20:59:08 +06:00
|
|
|
- New categories or improvements to the existing categorization are welcome.
|
2018-03-20 09:18:24 +06:00
|
|
|
- You can also add related links and repositories in the end.
|
2017-12-11 07:28:39 +06:00
|
|
|
|
2020-06-24 06:51:49 +06:00
|
|
|
[All suggestions are welcome](../../edit/master/readme.md).
|