learn-anything-books/contributing.md

1.1 KiB

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.
  • Use the following format: <📕 or 📖> [Name](link) (Year) - Description.
  • If you can't find the year the book was written in, you can skip adding the year.
  • 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 and add 📕 emoji.
  • The book should be put into its appropriate category. Pick the one you think is closest if you are not sure.
  • Sort the books inside a category from most recent to oldest.
  • Only add books you think are awesome.
  • 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.
  • Don't start the description with A or An.
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • You can also add related links and repositories in the end.

Thank you for your suggestions! 💜