Documentation Planning

• CONTRIBUTING.md documentation

• Need to establish internal workflow and processes
  • Security review process
  • Git flow process
  • Internal process should be documented internally
  • Version number process (e.g., Semantic versioning)
• Establish external contributing documentation
  • Should be shared in the CONTRIBUTING.md document
  • Establish coding standards/suggestions
  • Process to communicate with the City development team
  • Guidelines when opening issues, bugs, and enhancement requests
  • Establish the labels that will be used in Issues
• Place document in the CONTRIBUTING.md file in the repo

• LICENSE

• Choose a license for opengrid repo
  • Need to ensure compatibility between software and the license we choose
• Choose a license for opengrid service layer
  • Need to ensure compatibility between software and
• Place license in the LICENSE.md file in the repo

• ReadTheDocs Documentation

• User documentation
• Installation and setup
• Developer documentation
• Place documentation in the docs/ folder in the repo

• Testing protocol

• Desktop testing script
• Mobile device testing