This guide is intended to help codebase stewards start audits on a codebase.
As much as possible, audits should take place in the open and be done together with the community of the codebase.
- Get explicit approval to start an open audit by asking the maintainer. Consider communicating that audit is starting, preferrably by encouraging the maintainer to do it, and possibly on the blog as well.
- Create an issue in the repository for the codebase using the review template.
- Start auditing the codebase in collaboration with the community. Preferrably, this involves more than one key contributor from the community and more than one codebase steward working together.
- If the audit makes discoveries that can be addresses, create issues for those in the repository for the codebase, preferrably by encouraging the maintainer to do so.
- If many issues get created, ask to setup a Kanban in the repository for the audit with the columns Backlog, In progress, Done.
Public assessments are linked from each codebase on standard-compliant and if appropriate on our page for codebases in stewardship.