<aside> 💡 Request contract code review and anyone can review via Github Issues features

</aside>

Project FBI Overview

List of Requests

<aside> ❗ This section lists all active code review requests. Please do not modify this table. This table can be modified only by project owner (Harvey).

</aside>

1. Contract review request

<aside> ℹ️ Anyone working on the Tokamak Network project can request a code review.

Please be aware that the requester is responsible for making any necessary changes to the code based on the review and answering any questions that may arise from it.

</aside>

1. The requester creates a notion document (must be accessible by public).

   Contract review request form (copy this to your project Notion page)

2. Submit the request via Google Form (https://forms.gle/znwDS2Bmx5u3mAZ36)

   • After submission, project owner (Harvey) will review the request and list it under list of requests (will also share it with everyone)
   • Repository setting by project owner (Harvey)
     • if repository is under Tokamak Network Github, we will apply a branch protection on the review branch
     • if repository is under a personal Github, we will fork the repository to Tokamak Network Github, and invite you as a maintainer
   • If there is any issue, we will contact you

3. Contract review will start (Harvey will share the request with everyone)

4. Requester has to either make a new commit based on the review or explain the issue with the review (ex: duplicated issue, not an issue, etc)

5. The issue can be closed only by the person who submitted the review

2. Contract review process

<aside> ℹ️ Anyone can participate in code reviews and audits. It is reviewer’s responsibility to make sure that the code is fixed correctly, and only then the reviewer can close the issue.

</aside>

• Contract review is conducted using “issue” feature on Github repository
• All outstanding issues must be resolved → if you are the requester, make sure the resolution is checked by the issue creator

Submit review using “Issue” on Github

1. Press “New Issue” under Issues tab.

   

2. Set Issue title as “issue description”

   1. ex: Reentrancy vulnerability

3. Copy paste the following markdown code to the description box.

   **Describe the bug**
   A clear and concise description of what the bug is.
   
   **Configuration**
   - Severity:
   
   **Impact**
   A clear and concise description of what you expected to happen.
   
   **Recommendation**
   If applicable, add screenshots to help explain your Recommendation.
   
   **Exploit Scenario**
   
   **Demo**