Update Contributing
This commit is contained in:
parent
f88b13703d
commit
5f2189530b
|
@ -2,12 +2,12 @@
|
||||||
Ensure your pull request adheres to the following guidelines:
|
Ensure your pull request adheres to the following guidelines:
|
||||||
- Search included books before adding a new one, as yours may be a duplicate.
|
- Search included books before adding a new one, as yours may be a duplicate.
|
||||||
- Use the following format: `<📕 or 📖> [Name](link) (Year) - Description.`
|
- Use the following format: `<📕 or 📖> [Name](link) (Year) - Description.`
|
||||||
- Adding the Year is optional but is advised.
|
- If you can't find the year the book was written in, you can skip it.
|
||||||
- If the book is free, link to the free book and add 📖 emoji.
|
- If the book is free, link to the free book and add 📖 emoji and link to the free book.
|
||||||
- If the book is not free, link to the book on [Goodreads.com](https://www.goodreads.com/) 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.
|
- 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.
|
- If you want to add a link to notes for the book, add it below the book as subdashed point.
|
||||||
- Start the description with a capital and end with a full stop/period.
|
- Start the description with a capital and end with a full stop.
|
||||||
- Don't start the description with `A` or `An`.
|
- Don't start the description with `A` or `An`.
|
||||||
- New categories or improvements to the existing categorisation are welcome.
|
- New categories or improvements to the existing categorisation are welcome.
|
||||||
- Check your spelling and grammar.
|
- Check your spelling and grammar.
|
||||||
|
|
Loading…
Reference in New Issue