Skip to content

Commit c6189a2

Browse files
authored
Create CONTRIBUTING.md
1 parent 071c359 commit c6189a2

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

CONTRIBUTING.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
## The Goal
2+
Our goal is not to have the biggest list of stuff.
3+
Our goal is to have a **comprehensible** list of most valuable things any programmer should know about.
4+
5+
## Contributing
6+
7+
You contributions to this repo is always welcome!
8+
Bear in mind, that this repo is *highly opinionated* and *curated*.
9+
Your opinion on value of any resource may not match the opinion of curator.
10+
11+
**No PR will be discarded without explanations!**
12+
13+
14+
## Core Values
15+
*Values are clickable*
16+
17+
<details><summary>Less is more! :muscle:</summary><p>
18+
19+
We :heart: simplicity.<br>
20+
We :heart: essential stuff.<br>
21+
This is why we strive to having less, but most valuable resources in the list.
22+
</p></details>
23+
24+
<details><summary> We :heart: widely applicable knowledge/skills. </summary><p>
25+
26+
The world is not static. Everything changes.<br>
27+
This is why we prioritize strategically valuable skills/knowledge.<br>
28+
This is why there are so many philosophical resources in that list.
29+
</p></details>
30+
31+
<details><summary> We do not add to stress/hype level :zap: </summary><p>
32+
33+
There are enough stress sources in everybody's lifes.<br>
34+
We strive to be helpful without adding to the stress and creating hype.<br>
35+
Most endless stream resources (forums, newsletters, blogs, communities) are noisy and create questionable value.<br>
36+
Be mindful of that fact when adding resources.
37+
</p></details>
38+
39+
<details><summary>Technology is always about human beings :man: :woman: :baby:.</summary><p>
40+
41+
We do not code in sake of coding. We code to solve other people's problems.<br>
42+
This is why resources on soft skills are an essential part of that list.
43+
</p></details>
44+
45+
## Guidelines
46+
*Guidelines are clickable*
47+
48+
<details><summary>Do not add things you <b>have not evaluated</b> personally!</summary><p>
49+
50+
Use your critical thinking to filter out non-essential stuff.
51+
Give honest arguments for why the resource should be included.
52+
Have you read this book?
53+
Can you give a short article?
54+
</p></details>
55+
56+
<details><summary>Use reasoning based on our values.</summary><p>
57+
58+
Before adding any resource, answer this questions to yourself:
59+
- Will it make every programmer a better human being?
60+
- Will it change the quality of programmer's work?
61+
- Will it change the quality of programmer's life?
62+
- Would you personally recommend this resource to your friend, starting on software development career?
63+
64+
</p></details>
65+
66+
<details><summary><b>One item</b> per Pull Request.</summary><p>
67+
68+
There may be a discussion related to an item you want to add.
69+
Adding just a single item per pull request makes it much easier for everyone involved.
70+
</p></details>
71+
72+
<details><summary>Do not open issues with resources, create a Pull Request instead!</summary><p>
73+
74+
It is just easier to discuss and decide on a resource within a Pull Request.
75+
</p></details>
76+
77+
<details><summary>Use consistent set of resource type emoji</summary><p>
78+
79+
🎥 - Video/Talk
80+
📖 - Book
81+
📄 - Online article
82+
📜 - Paper/Document
83+
✅ - Checklist
84+
85+
</p></details>
86+

0 commit comments

Comments
 (0)