You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,7 @@ Example:
114
114
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF)
115
115
```
116
116
117
-
- Multiple formats:
117
+
- Multiple formats (We prefer a single link for each resource. When there is no single link with easy access to different formats, multiple links may make sense. But every link we add creates maintenance burden so we try to avoid it.):
118
118
119
119
```text
120
120
BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML)
@@ -189,13 +189,22 @@ Our lists provide a minimal set of metadata: titles, URLs, creators, platforms,
189
189
- You can shorten author lists with "`et al.`".
190
190
- We do not permit links for Creators.
191
191
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "`Compiled from StackOverflow documentation`".
192
+
- We do not include honorifics such as "Prof." or "Dr." in creator names.
193
+
194
+
195
+
##### Time-limited Courses and Trials
196
+
197
+
- We don't list things that we'll need to remove in six months.
198
+
- If a course has a limited enrollment period or duration, we won't list it.
199
+
- We can't list resources that are free for a limited period.
192
200
193
201
194
202
##### Platforms and Access Notes
195
203
196
204
- Courses. Especially for our course lists, the platform is an important part of the resource description. This is because course platforms have different affordances and access models. While we usually won't list a book that requires a registration, many course platforms have affordances that don't work without some sort of account. Example course platforms include Coursera, EdX, Udacity, and Udemy. When a course depends on a platform, the platform name should be listed in parentheses.
197
205
- YouTube. We have many courses which consist of YouTube playlists. We do not list YouTube as a platform, we try to list the YouTube creator, which is often a sub-platform.
198
-
- YouTube videos. We usually don't link to individual YouTube videos unless they are more than an hour long and are structured like a course or a tutorial.
206
+
- YouTube videos. We usually don't link to individual YouTube videos unless they are more than an hour long and are structured like a course or a tutorial. If this is the case, be sure to make a note of it in the PR description.
207
+
- No shortened (i.e. youtu.be/xxxx) links!
199
208
- Leanpub. Leanpub hosts books with a variety of access models. Sometimes a book can be read without registration; sometimes a book requires a Leanpub account for free access. Given quality of the books and the mixture and fluidity of Leanpub access models, we permit listing of the latter with the access note `*(Leanpub account or valid email requested)*`.
0 commit comments