2017-12-11 07:28:39 +06:00
|
|
|
# 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.
|
2018-01-03 18:24:10 +06:00
|
|
|
- Use the following format: `<📕 or 📖> [Name](link) (Year) - Description.`
|
2018-01-03 18:23:14 +06:00
|
|
|
- Adding the Year is optional but is advised.
|
2017-12-18 07:33:54 +06:00
|
|
|
- If the book is free, link to the free book and add 📖 emoji.
|
2017-12-18 07:33:01 +06:00
|
|
|
- If the book is not free, link to the book on [Goodreads.com](https://www.goodreads.com/) and add 📕 emoji.
|
2018-01-17 23:18:46 +06:00
|
|
|
- The book should be put into its appropriate category. Pick the one you think is closest if you are not sure.
|
2017-12-15 17:01:43 +06:00
|
|
|
- If you want to add a link to notes for the book, add it below the book as subdashed point.
|
2017-12-18 07:33:01 +06:00
|
|
|
- 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.
|
2017-12-15 17:01:43 +06:00
|
|
|
- Check your spelling and grammar.
|
2017-12-15 17:03:02 +06:00
|
|
|
- You can also add other related websites and repositories in the end.
|
2017-12-11 07:28:39 +06:00
|
|
|
|
2018-01-03 18:23:14 +06:00
|
|
|
Thank you for your [suggestions](https://github.com/learn-anything/books/edit/master/readme.md)! 💜
|