Skip to content

docs(CONTRIBUTING): improve guidelines #6878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 21, 2022
Merged

docs(CONTRIBUTING): improve guidelines #6878

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3f3153
docs(CONTRIBUTING): improve guidelines
LuigiImVector Jun 15, 2022
e685fe3
docs(CONTRIBUTING): new section
LuigiImVector Jun 19, 2022
1d5acae
Update docs/CONTRIBUTING.md
LuigiImVector Jun 20, 2022
80075b1
docs(CONTRIBUTING)
LuigiImVector Jun 20, 2022
4b30469
Update docs/CONTRIBUTING.md
LuigiImVector Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ By contributing you agree to respect the [Code of Conduct](CODE_OF_CONDUCT.md) o

- make sure a book is free. Double-check if needed. It helps the admins if you comment in the PR as to why you think the book is free.
- we don't accept files hosted on Google Drive, Dropbox, Mega, Scribd, Issuu and other similar file upload platforms
- insert your links in alphabetical order. If you see a misplaced link, please reorder it and submit a PR
- insert your links in alphabetical order. When there are multiple titles beginning with the same letter order them by the second, and so on. If you see a misplaced link, please reorder it and submit a PR
- use the link with the most authoritative source (meaning the author's website is better than the editor's website, which is better than a third party website)
- no file hosting services (this includes (but is not limited to) Dropbox and Google Drive links)
- always prefer a `https` link over a `http` one -- as long as they are on the same domain and serve the same content
Expand Down Expand Up @@ -156,6 +156,7 @@ Our lists provide a minimal set of metadata: titles, URLs, creators, platforms,

- No invented titles. We try to take titles from the resources themselves; contributors are admonished not to invent titles or use them editorially if this can be avoided. An exception is for older works; if they are primarily of historical interest, a year in parentheses appended to the title helps users know if they are of interest.
- No ALLCAPS titles. Usually title case is appropriate, but when doubt use the capitalization from the source
- No emoji or "weird" characters. The reading must be uniform.


##### URLs
Expand Down