{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "vuphongle-oss-pr-reviewer--review-one-pr-to-markdown-report",
 "repo": "vuphongle/oss-pr-reviewer",
 "repo_url": "https://github.com/vuphongle/oss-pr-reviewer",
 "repo_slug": "vuphongle-oss-pr-reviewer",
 "title": "Review one pull request and save a Markdown report",
 "page_title": "How to review one pull request and save a Markdown report with OSS PR Reviewer",
 "summary": "Generate a local AI review report for a single GitHub pull request to check before merging.",
 "who": "An open-source maintainer who has a pull request waiting and wants a structured first pass before doing their own review.",
 "problem": "Gathering changed files, finding patches that need attention, and writing up review notes takes time at the start of every review.",
 "outcome": "A review.md file with findings, pull request metadata, statistics, skipped files, and a disclaimer that the maintainer reads and acts on.",
 "steps": [
  "Clone the repository and run `npm install` in the checkout.",
  "Run `npm run build` to produce the dist folder.",
  "Run `export GITHUB_TOKEN=...` and `export OPENAI_API_KEY=...` with your own values.",
  "Run `node dist/cli/index.js review --repo owner/repository --pr 123 --min-severity medium --output review.md`. (inferred, check the README)",
  "Open review.md and check each finding against the pull request code before deciding anything."
 ],
 "agent_prompt": "In the vuphongle/oss-pr-reviewer checkout, build the CLI and run node dist/cli/index.js review --url <pull-request-url> --output review.md. Confirm review.md exists and list the findings with their severity and file path, noting any skipped files or an incomplete status. Do not approve or merge the pull request.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "The tool reviews only the supplied pull request metadata and patches, not the full repository, and it never claims a pull request is correct or safe.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "Node.js 20 LTS or newer",
  "A checkout of the vuphongle/oss-pr-reviewer repository",
  "An OpenAI API key set as OPENAI_API_KEY (required for live reviews)",
  "A GITHUB_TOKEN is recommended to avoid anonymous GitHub API rate limits",
  "Network access to GitHub and OpenAI"
 ],
 "risk": "sensitive",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "credentials",
   "notice": "The GitHub and OpenAI keys must stay in your environment; never paste them into the report, issues, or logs."
  }
 ],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/review-one-pr-to-markdown-report/",
 "md": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/review-one-pr-to-markdown-report/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/vuphongle-oss-pr-reviewer--review-one-pr-to-markdown-report.json",
 "api_version": "v1"
}