airship/docs
Code Issues Proposed changes
docs/doc/source/develop/conventions.rst
Ian H. Pittwood b29978f1fa Add issue tracking conventions 
Adds documentation for issue tracking in Github Issues for Airship
projects. Documentation covers issue submission, grooming, lifecycle,
and the Gerrit-to-Github-Issues bot.

Change-Id: I9833043ff53fbc3a68021dd3347c754821ec334b
2020-06-01 14:12:42 -05:00

1.5 KiB
Raw Permalink Blame History

Airship Conventions

Airship components conform to a minimal set of conventions to provide for reasonable levels of consistency.

Language

While these documents are not an IETF RFC, RFC 2119 provides for useful language definitions. In this spirit:

  • 'must', 'shall', 'will', and 'required' language indicates inflexible rules.
  • 'should' and 'recommended' language is expected to be followed but reasonable exceptions may exist.
  • 'may' and 'can' language is intended to be optional, but will provide a recommended approach if used.

Conventions and Standards

api-conventions code-conventions crd-conventions documentation-conventions issue-tracking-conventions service-logging-conventions