Skip to content

Commit 0b23c51

Browse files
committed
Update CONTRIBUTING.md guidelines.
Prefer one sentence per line with no line wrap under content/, since that keeps later diffs small. Keep the bugs list sorted by reported dates.
1 parent 7ff33db commit 0b23c51

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,18 @@ Preferences, not hard rules:
3636
produces readable diffs. The rendered text can still contain common special
3737
characters (e.g., Goldmark turns `--` into an en dash and `"` into curly
3838
quotes at build time).
39+
- One sentence per line and no line wrap in `content/`. This keeps later
40+
sentence edits as a one-line diff and avoids the need to re-wrap lines after
41+
an edit.
3942
- Org-level prose is first person plural.
4043
- Page images go in `static/images/`, referenced root-absolute
4144
(`/images/foo.png`). Resize before committing.
4245

4346
## Adding a bug
4447

45-
Append to the end of `data/bugs.yaml`. The header comment documents every field
46-
and the allowed values, and the build fails on anything outside them.
48+
Add your entry to `data/bugs.yaml`, keeping the bugs sorted by the `reported:`
49+
date. The header comment documents every field and the allowed values, and the
50+
build fails on anything outside them.
4751

4852
Two things you cannot copy straight off the upstream page:
4953

0 commit comments

Comments
 (0)