Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 435 Bytes

policy_Documentation_General.md

File metadata and controls

16 lines (12 loc) · 435 Bytes

core

General Documentation requirements

  • use topics in repo - easier to be found, indexed ...
  • project description
  • screenshots, terminal session recording (asciinema)
  • READMEs, a lot of READMEs - and badges for:
    • license
    • build status
    • code coverage
    • extra ... downloads / slack / other CIs / etc.

Reuse rights:

  • use some basic open source license from the start (usually MIT)