13 Commits

Author SHA1 Message Date
susan evans b6d6f850ba address feedback on style guide (#2675) 2023-04-10 17:41:57 -07:00
Bryce Lampe b10a614470 Fix typos (#2673) 2023-04-10 14:46:36 -07:00
Abhinav Gupta 51d52fa6b0 STYLE-GUIDE: Allow one-line-pargraph and sembr (#2633)
Per discussion with @cnunciato,
change the style guide to allow for one-line pargraphs
as well as sembr paragraphs.
The only form explicitly forbidden is reflowing text.

Moved the rationale into a `<details>` section
with examples demonstrating value of each case.
2023-03-31 13:16:20 -07:00
Abhinav Gupta 702f11719d STYLE-GUIDE: Suggest semantic line breaks (#2474)
Per Slack discussion,
changes the recommendation on writing paragraphs
to suggest semantic line breaks instead.

The rationale behind the original recommendation was that
it made it easier to suggest changes to a pargraph during code review.
However, that's also possible with multi-line pargraphs
because GitHub supports multi-line comments and suggestions.

This new recommendation includes a new rationale for the choice
as well as a note about leaving existing documentation alone
until it's modified.
2023-02-07 14:37:47 -08:00
susan evans 75b032664b update style guide to include sentence case (#1834) 2022-08-16 09:06:31 -07:00
Guinevere Saenger 36fd5e612e Include caveat on "simple" and "easy" (#1751) 2022-07-21 01:38:32 +00:00
susan evans 465dd1163b fix up style content in readme (#1446) 2022-05-01 09:57:45 -07:00
Christian Nunciato a8e80e7c61 Fix typo (#1375) 2022-04-15 13:02:59 -07:00
susan evans 7165165644 adding some content design guideliness (#1372) 2022-04-14 16:55:23 -07:00
susan evans 1b07f0a011 add note about redirects/aliases (#1240) 2022-03-21 17:09:05 -07:00
Josh Kodroff 93ec7cf591 Update STYLE-GUIDE.md (#917)
* Update STYLE-GUIDE.md

Add single-line paragraphs recommendation.

Co-authored-by: susan evans <susan.ra.evans@gmail.com>
2021-12-20 10:04:16 -05:00
Josh Kodroff 19f30b25ee Update STYLE-GUIDE.md (#895)
* Replace `-` for `<ul>`s with `*`, per Markdown spec.
* Touch up verbiage for neutrality, (hopefully) improved readability.
* Add link to Markdownlint.
2021-12-15 10:55:53 -05:00
susan evans 4c1469ae81 add style guide (#894) 2021-12-08 14:06:35 -08:00