Skip to content

Instantly share code, notes, and snippets.

@sapegin

sapegin/styleguide.md

Last active February 27, 2018 07:00
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sapegin/7baca588b4633cae49c24a251eee458b to your computer and use it in GitHub Desktop.
Save sapegin/7baca588b4633cae49c24a251eee458b to your computer and use it in GitHub Desktop.
Download ZIP
Raw
styleguide.md

English writing style guide

Style

  • Use American English
  • Always use sentence casing, even in headings.
  • Singular they
  • Use contractions: it’s, we’ll.
  • Ellipses in quotations: […].
  • 2 times → two times.
  • Use Arabic numerals for centuries: 19th century.
  • No smileys and emojis in articles.
  • Smiley always has a nose: :-)
  • “e.g.” → “for example”.
  • “i.e.” → “that is”.
  • “N.B.” → “note that”.
  • Avoid “etc.”, start lists with “like” instead: “Dwarves eats food like stone bread, chuf and dirsek.”
  • Put punctuation within quotations: ‘“stone bread,” “chuf,” and “dirsek.”‘

Formatting

  • Write filenames in bold: package.json.
  • Do not start terminal commands with $.

Dictionaries

Style guides

Reading

Tools

Textlint rules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment