Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents

Rules for Making Updates to Groundwater Specification

  1. Specification shall always be publicly available

  2. Specification shall adhere to style as defined in the NMWDI style guide

  3. Modification of the specification requires consent of majority of the active TWG members

  4. Modification of the specification requires a formal proposal following guidelines defined in NMWDI Specification Enhancement Proposal (SEP)

...

    1. Could be presented for review ahead of time for TWG members to review and approve at next meeting

    2. Information that should be included: what needs to change and why (question)

  1. Changes in new version should be documented

The Zen of NMWDI

(inspired by https://peps.python.org/pep-0020/ )

Code Block
Duplication is wasteful, linking is better
Data first, Apps second
Share the data you collect
Explicit is better than implicit
Consistent is good, standardized is better, validation is essential
Be Robust.  (Postel's Law: Be conservative in what you do, be liberal in what you accept from others.)

Style Guide

Rules:

  1. All lower case

  2. underscores between words

  3. spell out full words for clarity

  4. use nested properties instead of name qualifiers

Specification Enhancement Proposal Template