Skip to content

Commit 0aa9499

Browse files
docs(CONTRIBUTING): improve guidelines (EbookFoundation#6878)
* docs(CONTRIBUTING): improve guidelines * docs(CONTRIBUTING): new section * Update docs/CONTRIBUTING.md Co-authored-by: CleanMachine1 <[email protected]> * docs(CONTRIBUTING) Co-authored-by: CleanMachine1 <[email protected]> * Update docs/CONTRIBUTING.md Co-authored-by: CleanMachine1 <[email protected]>
1 parent b526bb9 commit 0aa9499

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

Diff for: docs/CONTRIBUTING.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ By contributing you agree to respect the [Code of Conduct](CODE_OF_CONDUCT.md) o
3636

3737
- 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.
3838
- we don't accept files hosted on Google Drive, Dropbox, Mega, Scribd, Issuu and other similar file upload platforms
39-
- insert your links in alphabetical order. If you see a misplaced link, please reorder it and submit a PR
39+
- insert your links in alphabetical order, as described [below](#alphabetical-order).
4040
- 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)
4141
- no file hosting services (this includes (but is not limited to) Dropbox and Google Drive links)
4242
- always prefer a `https` link over a `http` one -- as long as they are on the same domain and serve the same content
@@ -141,6 +141,13 @@ Example:
141141
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
142142
```
143143
144+
### Alphabetical order
145+
146+
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
147+
- `one two` comes before `onetwo`
148+
149+
If you see a misplaced link, check the linter error message to know which lines should be swapped.
150+
144151
145152
### Notes
146153
@@ -156,6 +163,7 @@ Our lists provide a minimal set of metadata: titles, URLs, creators, platforms,
156163
157164
- 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.
158165
- No ALLCAPS titles. Usually title case is appropriate, but when doubt use the capitalization from the source
166+
- No emojis.
159167
160168
161169
##### URLs

0 commit comments

Comments
 (0)