Note

By providing comprehensive documentation, well-defined tests, and an exact audit scope, your team will significantly expedite the auditing process. This ensures that we can begin our work without delays caused by missing or unclear information. While some checklist items may not be applicable to your project, filling in as much of the checklist as possible is highly encouraged, as it helps us better understand your system and saves valuable time for both teams. Clear and thorough submissions reduce the need for follow-ups, allowing the audit to progress more efficiently.

Instructions for Project Teams

1. Fork the Repository Privately

   • Please fork this repository privately to begin the pre-audit preparation.
   • Ensure that the forked repository is not publicly accessible.

2. Fill in the Templates

   • Navigate to the templates/ directory.
   • Fill in the consolidated markdown files with the relevant information for your project:
     • Documentation Checklist
     • Tests and Scripts Checklist
     • Scope and Audit Details

3. Provide Access for Review

   • Once completed, grant read access to our auditing team using their GitHub usernames or email addresses.
   • Notify us when the repository is ready for review.

---

Pre-Audit Checklist

1. Documentation Audit Checklist

   • Includes inline code documentation, component overview, design choices, deployment instructions, and diagrams.
   • Fill in the relevant sections in Documentation Checklist.

2. Tests Audit Checklist

   • Includes shell scripts, unit tests, and integration tests.
   • Provide the required details in Tests and Scripts Checklist.

3. Scope Audit Checklist

   • Define files in scope, LoC, and the commit hash and branch details.
   • Complete the relevant fields in Scope and Audit Details.