Skip to content

Commit c55ce2f

Browse files
committed
Add clarifications to CONTRIBUTING
In particular, this commit discusses what sort of resources I _won't_ accept, and why.
1 parent 45b9bc1 commit c55ce2f

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

CONTRIBUTING

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,45 @@
22

33
Thank you for contributing!
44

5-
You can contribute by either creating a pull request or by filing an [issue][is] on the issue tracker. In general, try and keep to one suggested change per pull request/issue. It's easier to work with a series of many small suggested changes rather then one large suggested change.
5+
You can contribute by either creating a pull request or by filing an
6+
[issue][is] on the issue tracker. In general, try and keep to one
7+
suggested change per pull request/issue. It's easier to work with a
8+
series of many small suggested changes rather then one large suggested
9+
change.
610

711
When suggesting a new resource or link to add, be sure to...
812

9-
1. Include a link to the resources and a brief description or annotation.
10-
2. Make sure the resource is high-quality
11-
3. Try and avoid overlap or too much redundancy between existing resources.
13+
1. Include a link to the resources and a brief description or annotation.
14+
2. Make sure the resource is high-quality
15+
3. Try and avoid overlap or too much redundancy between existing resources.
1216

13-
The goal of this collection is to create an annotated list of high-quality resources suitable for beginners or people wanting to improve their skill in an existing category. This collection is **not** meant to be an exhaustive list of every single possible resource, since that might be overwhelming for beginners.
17+
In addition, please keep in mind that at present time, I will generally NOT
18+
accept:
1419

15-
In addition, if you feel that two existing resources are very similar and that having both of them adds no value, or if one resource is too low-quality, please open a discussion on the issue tracker.
20+
1. Resources specific to a particular library or framework.
21+
22+
Currently, this resource is more oriented towards collecting resources for
23+
learning programming languages. I unfortunately don't have the time to do a
24+
thorough evaluation of all the different popular frameworks currently in use.
25+
26+
2. Content which can only be accessed through payment.
27+
28+
I _will_ make multiple exceptions to this rule, especially for books or
29+
for paid content which has a good number of positive critical reviews.
30+
Basically, I need some way of verifying that a given resource is
31+
high-quality, either by reading it myself or by relying on reviews by
32+
others.
33+
34+
Please note that the goal of this collection is to create an annotated list of
35+
high-quality resources suitable for beginners or people wanting to improve their
36+
skill in an existing category. This collection is **not** meant to be an exhaustive
37+
list of every single possible resource, since that might be overwhelming for
38+
beginners.
39+
40+
In addition, if you feel that two existing resources are very similar and that
41+
having both of them adds no value, or if one resource is too low-quality, please
42+
open a discussion on the issue tracker.
1643

1744
[is]: https://github.com/Michael0x2a/curated-programming-resources/issues
45+
46+

0 commit comments

Comments
 (0)