Skip to content

project_best_practices.md

Latest commit

 

History

History
9 lines (6 loc) · 781 Bytes

project_best_practices.md

File metadata and controls

9 lines (6 loc) · 781 Bytes

Project Documentation Best Practices

  1. All builds for testing and release must be produced, promoted and accessed from the build system.

  2. Projects must contain a readme with sufficient documentation that the project, with all its dependencies, can be set up, configured for release and built. see Project Setup Documentation

  3. All projects must develop and maintain a release checklist, this checklist must be used by the team for releases. see Release Checklist

  4. The repository must be tagged with a message mapping the last commit to the release number and date. see Versioning for Release