Skip to content

Commit

Permalink
Merge pull request #325 from publiccodenet/release-20231211
Browse files Browse the repository at this point in the history
Release 20231211
  • Loading branch information
Ainali authored Dec 12, 2023
2 parents f4ac0c3 + 3a6a248 commit 771c497
Show file tree
Hide file tree
Showing 14 changed files with 159 additions and 29 deletions.
Binary file added images/DPGA.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 105 additions & 0 deletions images/OSPO-Alliance.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions standard-for-public-code/certification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Standard compliance and certification process

<!-- SPDX-License-Identifier: CC0-1.0 -->
<!-- SPDX-FileCopyrightText: 2021-2023 The Foundation for Public Code <[email protected]> -->

The Foundation for Public Code can audit your codebase and community to verify if you are compliant with the Standard for Public Code.
This makes clear to potential users and contributors that the codebase is of high quality, and updates will be too.

The audit performed by the Foundation for Public Code is meant to complement machine testing, as machines are great at testing things like syntax and whether outcomes align with expectations.
Things meant for humans are impossible for machines to test, like whether documentation is actually understandable and accessible in context, the commit messages make sense, and community guidelines are being followed.

The audit tests the entire codebase, including source code, policy, documentation and conversation for compliance with both the standards set out by the Foundation for Public Code and the standards set out in the codebase itself.

Codebases that are fully compliant with the Standard for Public Code are listed at [standard-compliant.publiccode.net](https://standard-compliant.publiccode.net/).

[See the full stewardship lifecycle.](https://about.publiccode.net/activities/codebase-stewardship/lifecycle-diagram.html)

## How the process works

Every time a contribution is suggested to a codebase, for example through a merge request, the [codebase stewards](https://about.publiccode.net/roles/) of the Foundation for Public Code will audit the contribution for compliance with the Standard for Public Code.
New contributions can only be adopted into the codebase after they have been approved as compliant with the Standard for Public Code, and have been reviewed by another contributor.

The audit is presented as a review of the contribution.
The codebase steward gives line by line feedback and compliance, helping the contributor to improve their contribution.
The merge request cannot be fulfilled until the codebase stewards have approved the contribution.

![Pull Request Acceptance process](../images/audit-flow.svg)

## Certifying an entire codebase versus a contribution

For the codebase to be completely certified every meaningful line of code, and the commits behind the code, need to meet the Standard.

If codebases have been completely audited from the first merge request they can be immediately certified as compliant with the Standard for Public Code.

If the audit process is added to an existing codebase, the new merge requests can be certified, but the existing code will not be automatically certified.
By auditing every new merge request the codebase can move incrementally towards being completely certified.
The codebase stewards can also do a complete audit of a codebase, at the current commit, and start applying the process from then on to ensure that a codebase stays certified.
32 changes: 4 additions & 28 deletions standard-for-public-code/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,12 @@ The CITYxCITY Academy has a [free online course](https://citybycity.academy/cour

>[A video introduction to Standard for Public Code (4:12) on YouTube](https://www.youtube.com/watch?v=QWt6vB-cipE)
## Standard compliance or certification process
## Standard compliance and certification

The Foundation for Public Code ensures that codebases under its stewardship (and not in incubation or the attic) are compliant with the Standard for Public Code.
This makes clear to potential users and contributors that the codebase is of high quality, and updates will be too.
The Foundation for Public Code ensures that codebases under its stewardship are compliant with the Standard for Public Code.
We can also assess public code codebases not in stewardship if the codebase community is committed to becoming compliant with the Standard for Public Code.

The audit performed by the Foundation for Public Code is meant to complement machine testing, as machines are great at testing things like syntax and whether outcomes align with expectations.
Things meant for humans are impossible for machines to test, like whether documentation is actually understandable and accessible in context, the commit messages make sense, and community guidelines are being followed.

The audit tests the entire codebase, including source code, policy, documentation and conversation for compliance with both the standards set out by the Foundation for Public Code and the standards set out in the codebase itself.

### How the process works

Every time a contribution is suggested to a codebase, for example through a merge request, the [codebase stewards](https://about.publiccode.net/roles/) of the Foundation for Public Code will audit the contribution for compliance with the Standard for Public Code.
New contributions can only be adopted into the codebase after they have been approved as compliant with the Standard for Public Code, and have been reviewed by another contributor.

The audit is presented as a review of the contribution.
The codebase steward gives line by line feedback and compliance, helping the contributor to improve their contribution.
The merge request cannot be fulfilled until the codebase stewards have approved the contribution.

![Pull Request Acceptance process](../images/audit-flow.svg)

### Certifying an entire codebase versus a contribution

For the codebase to be completely certified every meaningful line of code, and the commits behind the code, need to meet the Standard.

If codebases have been completely audited from the first merge request they can be immediately certified as compliant with the Standard for Public Code.

If the audit process is added to an existing codebase, the new merge requests can be certified, but the existing code will not be automatically certified.
By auditing every new merge request the codebase can move incrementally towards being completely certified.
The codebase stewards can also do a complete audit of a codebase, at the current commit, and start applying the process from then on to ensure that a codebase stays certified.
If you are interested in this, check out the [process for certification](certification.md).

## The goals for the Standard for Public Code

Expand Down
5 changes: 4 additions & 1 deletion who-we-are/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ In 2022, we launched the Foundation for Public Code North America, to support gr

The Foundation for Public Code is a member of the [Digital Public Goods Alliance](https://digitalpublicgoods.net/) and a founding member of [OSPO Alliance](https://ospo.zone/).

![DPGA logo](../images/DPGA.png){:height="100px"}&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
![OSPO alliance logo](../images/OSPO-Alliance.svg){:height="100px"}

[See our blog](https://blog.publiccode.net/) for what we're up to now.

## The team
Expand Down Expand Up @@ -82,7 +85,7 @@ Together, we're a multidisciplinary team with years of experience in government
</svg>
</a>
<h3><a href="{{bio.url}}">{{ bio.title }}</a></h3>
<p>{{ bio.role }}</p>
<p>{{ bio.role }} <br /><a href="mailto:{{ bio.email }}">{{ bio.email }}</a></p>
</li>
{% endfor %}
</ul>
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/amy-darling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Operations, North America
image: amy-darling.jpg
email: [email protected]
---

# Amy Darling
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/ben-cerveny.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: President
image: ben-cerveny.jpg
email: [email protected]
redirect_from:
- team/ben-cerveny

Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/claus-mullie.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Coordinator codebase stewardship and community development
image: claus-mullie.jpg
email: [email protected]
redirect_from:
- team/claus-mullie
---
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/elena-findley-de-regt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Coordinator communications
image: elena-findley-de-regt.jpg
email: [email protected]
redirect_from:
- team/elena-findley-de-regt
---
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/eric-herman.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Lead codebase steward
image: eric-herman.jpg
email: [email protected]
redirect_from:
- team/eric-herman
---
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/jan-ainali.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Codebase steward
image: jan-ainali.jpg
email: [email protected]
redirect_from:
- team/jan-ainali
---
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/kehinde-bademosi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Storytelling strategist
image: kehinde-bademosi.jpg
email: [email protected]
---

# Kehinde Bademosi
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/matthew-claudel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Strategy, North America
image: matthew-claudel.png
email: [email protected]
---

# Matthew Claudel
Expand Down
1 change: 1 addition & 0 deletions who-we-are/team/max-carlson.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
type: Bio
role: Codebase steward, North America
image: max-carlson.jpeg
email: [email protected]
---

# Max Carlson
Expand Down

0 comments on commit 771c497

Please sign in to comment.