lib/Mind-Expanding-Books
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Vishnu Ks
2023-08-28 18:14:17 +01:00
committed by GitHub
parent 483e534fcd
commit 42a1065c48
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -1,13 +1,22 @@
# Contribution Guidelines # Contribution Guidelines
Please ensure your pull request adheres to the following guidelines: ## What is the criteria for adding a new book?
The mission of this list is to curate books that can change the life of people for better after reading them.
## If you are adding a new book So you should add books that have changed your life for better after reading them.
- If you want to add a new book you should have read the book. Here are some questions that you can potemtially ask to help make this descion for you. If the answer is yes to most of them feel free to create a pull request!
1. If you have the money to gift a book to the entire college graduates of this year would you gift this book?
2. Would you gift this book to your children at any point in their life?
3. If there are only 3 books that you can keep a physical copy of in your life, would this book be one of them?
4. Would your life would have been better off have you read this book 10 years back?
5. Would this book be relevant 1000 years from now?
## How to create a pull request?
- Search existing books in [README.md](README.md) and make sure that you are not adding a duplicate. - Search existing books in [README.md](README.md) and make sure that you are not adding a duplicate.
- Insert the book in the following format in [README.md](README.md). Don't change any other files. - Insert the book in the following format in [README.md](README.md). Don't change any other files.
`| Book name | Author | [Goodreads rating](Goodreads url) | Year published |` `| Book name | Author | [Goodreads rating](Goodreads url) | Year published |`
- Make sure that the book is inserted in the correct order according to the Goodreads rating. - Make sure that the book is inserted in the correct order according to the Goodreads rating.
- Mention in pull request clearly why you think the book deserve to be in the list. - Mention in pull request clearly why you think the book deserve to be in the list.