Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sambacha committed Sep 10, 2022
1 parent dea947c commit 993445c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ license: CC-SA-2.5
> NEW: OCI for Contracts
> OLD: NatSpec for frontend usage + Admonitions as @custom:tags
## Style Guide: Flight Rules

> informative style guide
What are "flight rules"?

A guide for astronauts about what to do when things go wrong.

> Flight Rules are the hard-earned body of knowledge recorded in manuals that list, step-by-step, what to do if X occurs, and why. Essentially, they are extremely detailed, scenario-specific standard operating procedures. [...]
> NASA has been capturing our missteps, disasters and solutions since the early 1960s, when Mercury-era ground teams first started gathering "lessons learned" into a compendium that now lists thousands of problematic situations, from engine failure to busted hatch handles to computer glitches, and their solutions.
> — Chris Hadfield, An Astronaut's Guide to Life on Earth.

## Example of @custom:natspec

```jsdoc
Expand Down

0 comments on commit 993445c

Please sign in to comment.