-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 9c5bca1
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Principles for Quality Code | ||
|
|
||
| Collaborative code development projects in the SCORE projects have to adhere to certain principles. This document is the standard. | ||
|
|
||
| > The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). | ||
| Projects MUST: | ||
|
|
||
| * have a `README` with a description of the codebases for the potential users/implementers | ||
| * explain in the `README` how to run, develop and build | ||
| * be developed in a public repository from the start | ||
| * provide a link to a public list of known issues and bugs | ||
| * allow non-contributors to post issues, bugs and suggested changes | ||
| * have functional tests | ||
| * have documentation for all public APIs | ||
| * have a `LICENCE` with an [Open Source Initiative designated "Popular License"](https://opensource.org/licenses/category) or [EUPL](https://eupl.eu/) | ||
|
|
||
| Projects SHOULD: | ||
|
|
||
| * have a high level discription for (technical) management to understand in the `README` | ||
| * respond to incoming issues and change suggestions within a week | ||
| * provide contributors guidelines in a `CONTRIBUTING` file | ||
| * set up any tests to run in a public continuous integration environment | ||
| * have test and documentation code coverage to the highest degree possible | ||
| * have documented private APIs | ||
| * use a version number compatible with [Semantic Versioning](https://semver.org/) | ||
| * provide documentation on privacy and security | ||
| * contain configurations for automatic deployment and provisioning through systems such as Docker, Ansible, CloudForge etc | ||
|
|
||
| Projects MAY: | ||
|
|
||
| * publish a roadmap | ||
| * provide a forum or mailing list for discussion | ||
| * publish packages to relevant language specific repositories such as PyPi, Ruby Gems, NPM, Puppet Forge, etc | ||
| * provide a contribution and governance model in a `GOVERNANCE` file | ||
| * indicate the level of maintainance provided by whom and until when | ||
| * indicate a codebase/project status in the `README` | ||
| * "Ideation" - Brainstorming phase | ||
| * "Alpha" - Brainstorming phase | ||
| * "Beta" - Brainstorming phase | ||
| * "Production" - Finished Product, development ongoing | ||
| * "Archival" - Finished Product, development no longer ongoing | ||
| * provide a list of contributors in a `CONTRIBUTORS` file |