City of Edmonton Open Source Checklist

Purpose

This document will detail the basic requirments for becoming a well run open source project. Credit to the great opensource.guide for guiding some of our thoughts on this. Credit also goes to GDS for showing government services can built in an open, efficient way.

Guidelines

Projects must

• include a README
• include useful and informative commit messages about why a change was made
• include a valid Open Source LICENSE file (see example)
• provide a link to a public list of known issues and bugs
• provide an email address to send security related bug reports to
• provide a version number compatible with Semantic Versioning

Projects should

• publish packages to relevant language specific repositories such as PyPi, Ruby Gems, NPM, Nuget, etc.
• publish contributors guidelines in a CONTRIBUTING file
• set up any tests to run in a public continuous integration environment such as Travis CI

Projects may

• include a CONTRIBUTORS file
• provide a mailing list for discussion of the project