From f9baab5f2ffeff8a86ac7aebca1cc8379e5d3ffa Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 15:33:17 +0200 Subject: [PATCH 1/8] Add CONTRIBUTING to everywhere the Standard recommends it --- criteria/maintain-version-control.md | 3 +++ criteria/use-a-coherent-style.md | 4 ++++ criteria/welcome-contributors.md | 3 ++- 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/criteria/maintain-version-control.md b/criteria/maintain-version-control.md index f6c9e02..e735c53 100644 --- a/criteria/maintain-version-control.md +++ b/criteria/maintain-version-control.md @@ -40,6 +40,9 @@ Git is great. ### Contribution guidelines SHOULD require contributors to group relevant changes in commits. +* [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + + ### Maintainers SHOULD mark released versions of the codebase, for example using revision tags or textual labels. #### Examples diff --git a/criteria/use-a-coherent-style.md b/criteria/use-a-coherent-style.md index 7368fd6..4a5fba0 100644 --- a/criteria/use-a-coherent-style.md +++ b/criteria/use-a-coherent-style.md @@ -10,6 +10,10 @@ edirect_from: ## Requirements +* [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). GitHub links CONTRIBUTING in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + + + ## Use a coherent style ### The codebase MUST use a coding or writing style guide, either the codebase community's own or an existing one referred to in the codebase. diff --git a/criteria/welcome-contributors.md b/criteria/welcome-contributors.md index bad4e00..78b3384 100644 --- a/criteria/welcome-contributors.md +++ b/criteria/welcome-contributors.md @@ -22,7 +22,8 @@ redirect_from: #### Resources -* [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) +* [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + #### Examples From 1ea77736dfb37e86c29218f4b335ad686a7c6dc2 Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 15:39:22 +0200 Subject: [PATCH 2/8] Add Code of Conduct --- criteria/welcome-contributors.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/criteria/welcome-contributors.md b/criteria/welcome-contributors.md index 78b3384..3a06f30 100644 --- a/criteria/welcome-contributors.md +++ b/criteria/welcome-contributors.md @@ -81,6 +81,11 @@ This could also be solved by having public task boards/kanban boards with suitab ### Including a code of conduct for contributors in the codebase is OPTIONAL. +#### Resources + +* [Instructions for adding a CODE_OF_CONDUCT file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). This includes templates for common Codes of Conduct (including the Contributor Covenant), and links in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + + #### Examples * [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/) is a code of conduct with a set of core values and norms that are essential in a just and equitable software commons. It can be adapted to include the special shared values and norms particular to your own community and its members. From 4f1e8af54986dbf1a911158a64d7ebd0be17e803 Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 15:40:09 +0200 Subject: [PATCH 3/8] code of conduct language improvement --- criteria/welcome-contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/criteria/welcome-contributors.md b/criteria/welcome-contributors.md index 3a06f30..7f4d2be 100644 --- a/criteria/welcome-contributors.md +++ b/criteria/welcome-contributors.md @@ -83,7 +83,7 @@ This could also be solved by having public task boards/kanban boards with suitab #### Resources -* [Instructions for adding a CODE_OF_CONDUCT file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). This includes templates for common Codes of Conduct (including the Contributor Covenant), and links in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). +* [Instructions for adding a CODE_OF_CONDUCT file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). This includes templates for common Codes of Conduct (like the Contributor Covenant), and is linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). #### Examples From f2048a1dcf045a358ee6a64cfcc22d693412bdfd Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 15:50:56 +0200 Subject: [PATCH 4/8] add license file --- criteria/publish-with-an-open-license.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/criteria/publish-with-an-open-license.md b/criteria/publish-with-an-open-license.md index b2f6fe5..9b5ee15 100644 --- a/criteria/publish-with-an-open-license.md +++ b/criteria/publish-with-an-open-license.md @@ -28,6 +28,9 @@ redirect_from: ### All source code MUST be published with a license file. +* [Instructions for adding a LICENSE file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). This includes templates for common open source licenses, and is linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + + ### Contributors MUST NOT be required to transfer copyright of their contributions to the codebase. This may be impossible for civil servants in some jurisdictions so if that is a requirement they are effectively prohibited from contributing. From d30c24cd957b2c4f4224f602c3f742751ba1382e Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 16:07:20 +0200 Subject: [PATCH 5/8] SECURITY ADDED, page content deduped --- criteria/make-contributing-easy.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/criteria/make-contributing-easy.md b/criteria/make-contributing-easy.md index 16fa638..1a657f0 100644 --- a/criteria/make-contributing-easy.md +++ b/criteria/make-contributing-easy.md @@ -17,13 +17,6 @@ order: 5 * (add a good gitlab example) * [Tasks in Phabricator](https://phabricator.wikimedia.org/maniphest/) -### The codebase MUST include instructions for how to privately report security issues for responsible disclosure. - -#### Examples - -* [OpenZaak SECURITY](https://github.com/open-zaak/open-zaak/blob/main/SECURITY.rst) -* [Verdaccio SECURITY](https://github.com/verdaccio/verdaccio/blob/master/SECURITY.md) - ### The documentation MUST link to both the public issue tracker and submitted codebase changes, for example in a README file. In many platforms, like GitHub, GitLab, Gitea etc. these links are automatically provided in the interface. If you don't use the features of the platform, for example if you have a separate issue tracker, then you must provide these links. @@ -74,13 +67,19 @@ Preferably, anyone should be able to join these and start discussing without req * [CivicTech Sweden (matrix)](https://app.element.io/#/room/#civictechse:matrix.org) * [Publiccode.yml forum (GitHub discussions)](https://github.com/publiccodeyml/publiccode.yml/discussions) -### There MUST be a way to report security issues for responsible disclosure over a closed channel. +### The codebase MUST include instructions for how to privately report security issues for responsible disclosure. -#### Examples +#### Resources -### The documentation MUST include instructions for how to report potentially security sensitive issues. +* [Instructions for adding a SECURITY file on GitHub](https://docs.github.com/en/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/add-security-policy). This is includes a minimal template and can be used to set up a 'report a vulnerability' button. It's also linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). #### Examples * [OpenZaak SECURITY](https://github.com/open-zaak/open-zaak/blob/main/SECURITY.rst) * [Verdaccio SECURITY](https://github.com/verdaccio/verdaccio/blob/master/SECURITY.md) + +#### Examples + +### The documentation MUST include instructions for how to report potentially security sensitive issues. + + From 6c45b18245586a228b91afc4adcaafc5fb924587 Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 16:20:57 +0200 Subject: [PATCH 6/8] instructions for adding a readme --- criteria/document-codebase-objectives.md | 4 ++++ criteria/document-the-code.md | 1 + criteria/make-contributing-easy.md | 4 ++++ 3 files changed, 9 insertions(+) diff --git a/criteria/document-codebase-objectives.md b/criteria/document-codebase-objectives.md index 14e3cc6..d9328a2 100644 --- a/criteria/document-codebase-objectives.md +++ b/criteria/document-codebase-objectives.md @@ -25,6 +25,10 @@ Be on the lookout for people, organizations and initiatives with similar objecti ### Codebase documentation SHOULD clearly describe the connections between policy objectives and codebase objectives. +#### Resources + +* [Instructions for adding a README file on GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes). This is linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + #### Examples ### Documenting the objectives of the codebase for the general public is OPTIONAL. diff --git a/criteria/document-the-code.md b/criteria/document-the-code.md index 28dfa8c..6fc9c40 100644 --- a/criteria/document-the-code.md +++ b/criteria/document-the-code.md @@ -20,6 +20,7 @@ redirect_from: ### Resources * [How to write a README](https://github.com/Amsterdam/amsterdam.github.io/blob/master/guides/write-a-readme.md), guide from the municipality of Amsterdam. +* [Instructions for adding a README file on GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes). This is linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). ## Requirements diff --git a/criteria/make-contributing-easy.md b/criteria/make-contributing-easy.md index 1a657f0..3eff078 100644 --- a/criteria/make-contributing-easy.md +++ b/criteria/make-contributing-easy.md @@ -21,6 +21,10 @@ order: 5 In many platforms, like GitHub, GitLab, Gitea etc. these links are automatically provided in the interface. If you don't use the features of the platform, for example if you have a separate issue tracker, then you must provide these links. +#### Resources + +* [Instructions for adding a README file on GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes). This is linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). + #### Further reading * [18Fs Open Source Guide on `README`s](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md) From eb20b9f0945b4a98aef6d21fb1ff25d81a3461cb Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Mon, 22 Jun 2026 17:25:52 +0200 Subject: [PATCH 7/8] delinting --- criteria/maintain-version-control.md | 1 - criteria/make-contributing-easy.md | 2 -- criteria/publish-with-an-open-license.md | 1 - criteria/use-a-coherent-style.md | 2 -- criteria/welcome-contributors.md | 2 -- 5 files changed, 8 deletions(-) diff --git a/criteria/maintain-version-control.md b/criteria/maintain-version-control.md index e735c53..644f551 100644 --- a/criteria/maintain-version-control.md +++ b/criteria/maintain-version-control.md @@ -42,7 +42,6 @@ Git is great. * [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). - ### Maintainers SHOULD mark released versions of the codebase, for example using revision tags or textual labels. #### Examples diff --git a/criteria/make-contributing-easy.md b/criteria/make-contributing-easy.md index 3eff078..55d0c3a 100644 --- a/criteria/make-contributing-easy.md +++ b/criteria/make-contributing-easy.md @@ -85,5 +85,3 @@ Preferably, anyone should be able to join these and start discussing without req #### Examples ### The documentation MUST include instructions for how to report potentially security sensitive issues. - - diff --git a/criteria/publish-with-an-open-license.md b/criteria/publish-with-an-open-license.md index 9b5ee15..7eadccb 100644 --- a/criteria/publish-with-an-open-license.md +++ b/criteria/publish-with-an-open-license.md @@ -30,7 +30,6 @@ redirect_from: * [Instructions for adding a LICENSE file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). This includes templates for common open source licenses, and is linked as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). - ### Contributors MUST NOT be required to transfer copyright of their contributions to the codebase. This may be impossible for civil servants in some jurisdictions so if that is a requirement they are effectively prohibited from contributing. diff --git a/criteria/use-a-coherent-style.md b/criteria/use-a-coherent-style.md index 4a5fba0..e7354ed 100644 --- a/criteria/use-a-coherent-style.md +++ b/criteria/use-a-coherent-style.md @@ -12,8 +12,6 @@ edirect_from: * [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). GitHub links CONTRIBUTING in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). - - ## Use a coherent style ### The codebase MUST use a coding or writing style guide, either the codebase community's own or an existing one referred to in the codebase. diff --git a/criteria/welcome-contributors.md b/criteria/welcome-contributors.md index 7f4d2be..3e93e44 100644 --- a/criteria/welcome-contributors.md +++ b/criteria/welcome-contributors.md @@ -24,7 +24,6 @@ redirect_from: * [Instructions for adding a CONTRIBUTING file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). - #### Examples * [OpenZaak CONTRIBUTING](https://github.com/open-zaak/open-zaak/blob/main/CONTRIBUTING.md) @@ -85,7 +84,6 @@ This could also be solved by having public task boards/kanban boards with suitab * [Instructions for adding a CODE_OF_CONDUCT file on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). This includes templates for common Codes of Conduct (like the Contributor Covenant), and is linked in multiple places as part of a [repo's community profile](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories). - #### Examples * [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/) is a code of conduct with a set of core values and norms that are essential in a just and equitable software commons. It can be adapted to include the special shared values and norms particular to your own community and its members. From db9ac25830cb35489b122cb52709f10ff4f0e73c Mon Sep 17 00:00:00 2001 From: Elena Findley-de Regt Date: Thu, 25 Jun 2026 17:34:49 +0200 Subject: [PATCH 8/8] Update text to match Standard v 8.1 --- criteria/make-contributing-easy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/criteria/make-contributing-easy.md b/criteria/make-contributing-easy.md index 55d0c3a..7a22e69 100644 --- a/criteria/make-contributing-easy.md +++ b/criteria/make-contributing-easy.md @@ -71,7 +71,7 @@ Preferably, anyone should be able to join these and start discussing without req * [CivicTech Sweden (matrix)](https://app.element.io/#/room/#civictechse:matrix.org) * [Publiccode.yml forum (GitHub discussions)](https://github.com/publiccodeyml/publiccode.yml/discussions) -### The codebase MUST include instructions for how to privately report security issues for responsible disclosure. +### There MUST be a way to report security issues for responsible disclosure over a closed channel. #### Resources @@ -82,6 +82,6 @@ Preferably, anyone should be able to join these and start discussing without req * [OpenZaak SECURITY](https://github.com/open-zaak/open-zaak/blob/main/SECURITY.rst) * [Verdaccio SECURITY](https://github.com/verdaccio/verdaccio/blob/master/SECURITY.md) -#### Examples - ### The documentation MUST include instructions for how to report potentially security sensitive issues. + +#### Examples