Code

Write best practices and style guide#904

Code

Merged

fdncred merged 38 commits intonushell:mainnushell/nushell.github.io:mainfrom EmilyGraceSeville7cf:feature/add-best-practicesEmilyGraceSeville7cf/nu-site:feature/add-best-practicesCopy head branch name to clipboardSep 30, 2023

+194

Commits

Commits on May 10, 2023

• feat(practices): options and parameters

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  9c2037d

  Copy full SHA for 9c2037d

Commits on May 11, 2023

• feat(practices): require docs for exported things

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  efc10cb

  Copy full SHA for efc10cb

• feat(practices): explain formatting

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  1338aac

  Copy full SHA for 1338aac

• feat(practices): add example

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  1b63ecf

  Copy full SHA for 1b63ecf

• feat(practices): extend first formatting rule

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  d649d4a

  Copy full SHA for d649d4a

• feat(practices): rewrite formatting rules

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  89bf85b

  Copy full SHA for 89bf85b

• feat(practices): add examples

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  1e8c1d8

  Copy full SHA for 1e8c1d8

• feat(practices): note about keeping indent

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  062e1d0

  Copy full SHA for 062e1d0

• feat(practices): add list formatting

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  ecfb91c

  Copy full SHA for ecfb91c

• feat(practices): make rules sound more polite

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  8980677

  Copy full SHA for 8980677

• feat(practices): add note

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  d8aca9f

  Copy full SHA for d8aca9f

• feat(practices): clarify one-line format rules

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  ef39d60

  Copy full SHA for ef39d60

• feat(practice): clean-up

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  3fdc3d3

  Copy full SHA for 3fdc3d3

• fix(practices): remove duplicates

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  aedbc9c

  Copy full SHA for aedbc9c

• feat(practices): update examples

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  930df0d

  Copy full SHA for 930df0d

• feat(practices): recommend omit commas

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  0639f71

  Copy full SHA for 0639f71

• feat(practices): allow short format more

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  ca6ce66

  Copy full SHA for ca6ce66

Commits on May 13, 2023

• feat(practices): make intro less authoritative

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  a2dac57

  Copy full SHA for a2dac57

• feat(practices): move comments on separate lines

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  b8de74f

  Copy full SHA for b8de74f

• feat(practices): note about escape sequences

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  d18a100

  Copy full SHA for d18a100

• feat(practices): unify collection syntax

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  aef4ac8

  Copy full SHA for aef4ac8

• feat(practices): narrow down amount of args

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  1cfefea

  Copy full SHA for 1cfefea

• fix(practices): deduplicate terms

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  6a22d9d

  Copy full SHA for 6a22d9d

• fix(practices): require trailing space omission

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  5efba81

  Copy full SHA for 5efba81

• tweaked some grammar, removed some optional commas

  fdncred

  authored
  c9f61d2

  Copy full SHA for c9f61d2

Commits on May 14, 2023

• feat(practices): join sections

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  cd765c2

  Copy full SHA for cd765c2

• Merge branch 'feature/add-best-practices' of https://github.com/EmilySeville7cfg/nu-site into feature/add-best-practices

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  2ffc8ab

  Copy full SHA for 2ffc8ab

• feat(practices): clarify when use and what format

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  6852d1e

  Copy full SHA for 6852d1e

Commits on May 17, 2023

• feat(practices): update examples

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  80af021

  Copy full SHA for 80af021

• feat(practices): dealing with parenthesis

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  4269691

  Copy full SHA for 4269691

• feat(practices): forbid consecutive spaces

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  300cf67

  Copy full SHA for 300cf67

• feat(practices): add spacing between constructs

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  4b47366

  Copy full SHA for 4b47366

• feat(practices): simplify rules

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  88565ff

  Copy full SHA for 88565ff

• feat(practices): clarify rules for parenthesis

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  d969521

  Copy full SHA for d969521

• feat(practices): spacing when no params defined

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  ebf66a4

  Copy full SHA for ebf66a4

• Update book/style_guide.md

  Show description for 3616f66
  

  Emily Grace Seville

  and

  fdncred

  authored
  3616f66

  Copy full SHA for 3616f66

Commits on Jun 18, 2023

• Merge branch 'main' into feature/add-best-practices

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  8d01d4f

  Copy full SHA for 8d01d4f

• Merge branch 'feature/add-best-practices' of https://github.com/EmilySeville7cfg/nu-site into feature/add-best-practices

  

  EmilySeville7cfg

  authored and

  EmilySeville7cfg

  committed
  a433170

  Copy full SHA for a433170