lists/every-programmer-should-know
1
0
Fork 0
mirror of https://github.com/mtdvio/every-programmer-should-know.git synced 2025-01-16 22:08:14 +01:00
Code Issues Releases Wiki Activity

Update wording in CONTRIBUTING.md, closes #93

Browse Source
This commit is contained in:
Joe Block 2017-12-06 08:26:54 -07:00
parent aa6eaffe82
commit 0701ee6b81
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
CONTRIBUTING.md
View File

@ -1,12 +1,12 @@
## The Goal ## The Goal
Our goal is not to have the biggest list of stuff. Our goal is not to have the biggest list of stuff.
Our goal is to have a **comprehensible** list of most valuable things any programmer should know about. Our goal is to have a **comprehensible** list of most valuable things any programmer should know about.
## Contributing ## Contributing
Your contributions to this repo are always welcome! Your contributions to this repo are always welcome!
Bear in mind, that this repo is *highly opinionated* and *curated*. Bear in mind, that this repo is *highly opinionated* and *curated*.
Your opinion on value of any resource may not match the opinion of curator. Your opinion on value of any resource may not match the opinion of curator.
**No PR will be discarded without explanations!** **No PR will be discarded without explanations!**
@ -18,7 +18,7 @@ Your opinion on value of any resource may not match the opinion of curator.
We :heart: simplicity.<br> We :heart: simplicity.<br>
We :heart: essential stuff.<br> We :heart: essential stuff.<br>
This is why we strive to having less, but most valuable resources in the list. We strive to have a smaller list of more valuable resources, quality over quantity.
</p></details> </p></details>
<details><summary>We :heart: widely applicable knowledge/skills. </summary><p> <details><summary>We :heart: widely applicable knowledge/skills. </summary><p>
@ -47,25 +47,25 @@ This is why resources on soft skills are an essential part of that list.
<details><summary>Do not add things you <b>have not evaluated</b> personally!</summary><p> <details><summary>Do not add things you <b>have not evaluated</b> personally!</summary><p>
Use your critical thinking to filter out non-essential stuff. Use your critical thinking to filter out non-essential stuff.
Give honest arguments for why the resource should be included. Give honest arguments for why the resource should be included.
Have you read this book? Have you read this book?
Can you give a short article? Can you give a short article?
</p></details> </p></details>
<details><summary>Use reasoning based on our values.</summary><p> <details><summary>Use reasoning based on our values.</summary><p>
Before adding any resource, answer this questions to yourself: Before adding any resource, answer this questions to yourself:
- Will it make every programmer a better human being? - Will it make every programmer a better human being?
- Will it change the quality of programmer's work? - Will it change the quality of programmer's work?
- Will it change the quality of programmer's life? - Will it change the quality of programmer's life?
- Would you personally recommend this resource to your friend, starting on software development career? - Would you personally recommend this resource to your friend, starting on software development career?
</p></details> </p></details>
<details><summary><b>One item</b> per Pull Request.</summary><p> <details><summary><b>One item</b> per Pull Request.</summary><p>
There may be a discussion related to an item you want to add. There may be a discussion related to an item you want to add.
Adding just a single item per pull request makes it much easier for everyone involved. Adding just a single item per pull request makes it much easier for everyone involved.
</p></details> </p></details>
@ -76,11 +76,11 @@ It is just easier to discuss and decide on a resource within a Pull Request.
<details><summary>Use consistent set of resource type emoji</summary><p> <details><summary>Use consistent set of resource type emoji</summary><p>
🎥 - Video/Talk 🎥 - Video/Talk
📖 - Book 📖 - Book
📄 - Online article 📄 - Online article
📜 - Paper/Document 📜 - Paper/Document
✅ - Checklist ✅ - Checklist
</p></details> </p></details>