Lonely Planet Arbitrary Choices Repository

Tags

How to write a standard

last updated: 29 Aug 2013

TLDR;

Describes the agreed standard, and should be enough that most of the time you don’t need to read the rest.

This may be as simple as use lp_code_standards gem and include lp_code_standards in build.

Situation

Describes the situation that this standard is for.

Standards are for where different teams are or could make different choices for the same situation. Make a standard if you think it is useful.

A standard could be a problem that is resolved with code.

Criteria

  • Each requirement/criterion should be clearly defined.
  • Put all the criteria here so that later on, we can understand why this was a good decision.

Examined alternatives

Describes all the alternatives that were examined.

  • Each alternative should have a brief description with pros and cons

Tips

Describes useful things about the use of this standard that may not be otherwise obvious.

  • When creating a standard use be jekyll serve --watch to see it locally.
  • Standards should always be created as pull-requests.