Skip to content

Technical Assessment Report Generation Prompt

Generate a rich HTML technical review report for the whole repo

Scan through the whole project source code and generate a technical review report.

Output Format & Structure

  • Output the report as an HTML document with table of content in /doc folder
  • The name of the report file: technical-review_.html
  • Mention the current git branch as part of h3 sub-title
  • Mention the date when the report is generated
  • Start with TOC that include all the headers
  • Followed by Exective Summary, include the repo stats below:
  • Include Total number of src files (excluding non-src files)
  • Totla lines of code in the repo
  • Followeed by the findings one by one
  • Each finding should have its own header
  • Apply numbering on findings header
  • Sort the findings based on severity: critical, high, medium, low ...
  • Do not inlcude Introduction or Conclusion sections.

Finding Details

Each finding should contain the following: - summary - severity - details descriptions - src files occurrence with line number/range - code snippets - recommended remediations

Styling

Use the styling based the CSS code only: ``` ```