Skip to content

Commit 0169bc3

Browse files
erichermanAinali
andcommitted
Add initial assessment description
fixes #1418 Co-authored-by: Jan Ainali <jan@publiccode.net>
1 parent 9764da1 commit 0169bc3

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

activities/codebase-auditing/auditing-process.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,26 @@ type: Resource
66

77
# The auditing process
88

9+
Initially, codebase stewards schedule time with codebase maintainers in order to review each requirement of each criterion relative to the codebase.
10+
For each requirement, the stewards and the maintainers come to a shared understanding of what the current state is as well as what changes, if any, should be made to bring the codebase closer to compliance with the requirement.
11+
12+
As a help to review a codebase, [this template](https://github.com/publiccodenet/standard/blob/develop/docs/review-template.html) can be used.
13+
14+
By recording the current state, and taking notes including links to supporting documentation in the template, progress can be tracked over time.
15+
16+
Assessments are typically added to the codebase repository, which allows others to verify or challenge the evaluation.
17+
18+
The initial assessments can usually be performed with two to three sessions of two to three hours each for the maintainers and the stewards.
19+
20+
## Continuous auditing
21+
922
The audit happens completely in the version control platform and is designed to fit in to a regular agile software development process.
1023
When a contribution is presented for inclusion in the codebase, a Foundation for Public Code staff auditor familiar with the codebase will provide a review or certify the contribution.
1124

1225
The review or certification will happen within 2 business days to enable agile development and not block users and maintainers from making progress.
1326

1427
The codebase maintainers will be notified when a contribution passes the audit and is certified.
1528

16-
## Template
17-
18-
As a help to review a codebase, [this template](https://github.com/publiccodenet/standard/blob/develop/docs/review-template.html) can be used.
19-
2029
## List of assessments
2130

2231
For any codebase where there is not yet an explicit agreement to publish an assessment, or one in progress, add the link to the assessment to [this spreadsheet](https://docs.google.com/spreadsheets/d/1wUrlZ73S-4BK3sGz87C28d0ReYELCCP4MZnKpB0UKqM/edit#gid=2105222073) (only accessible for staff).

0 commit comments

Comments
 (0)