{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "vuphongle-oss-pr-reviewer--set-repo-review-rules-and-ignored-paths",
 "repo": "vuphongle/oss-pr-reviewer",
 "repo_url": "https://github.com/vuphongle/oss-pr-reviewer",
 "repo_slug": "vuphongle-oss-pr-reviewer",
 "title": "Set repo-specific review rules and ignored paths",
 "page_title": "How to set repo-specific review rules and ignored paths with OSS PR Reviewer",
 "summary": "Add a base-branch config file that sets minimum severity, custom rules, and ignored paths.",
 "who": "A maintainer who wants reviews to follow the project's own expectations, such as requiring tests for changes under src/.",
 "problem": "Generic review guidance misses project conventions, and generated or documentation files add noise to every review.",
 "outcome": "A .oss-pr-reviewer.yml file on the base branch that sets the default minimum severity, adds rules, and excludes paths before AI review.",
 "steps": [
  "Copy examples/oss-pr-reviewer.yml from the checkout as a starting point.",
  "Edit the review.minSeverity, rules, and ignore.paths entries to fit your project.",
  "Commit the file to the base branch, since the tool loads it from the pull request's base commit rather than the PR branch.",
  "Run `node dist/cli/index.js review --repo owner/repository --pr 123 --min-severity medium --output review.md` and check the skipped-file section of the report. (inferred, check the README)"
 ],
 "agent_prompt": "In the oss-pr-reviewer checkout, read docs/configuration.md and create a .oss-pr-reviewer.yml for <owner/repository> with one rule and one ignored path. Verify the YAML parses and that the ignored path is listed in the skipped-file section of a generated report. Do not place the file on a pull request branch.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "Rule text is treated as untrusted guidance, and CLI options override the repository file, so a flag can change the result you expect from the config.",
 "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": [],
 "best": false,
 "score": 0.7,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/set-repo-review-rules-and-ignored-paths/",
 "md": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/set-repo-review-rules-and-ignored-paths/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--set-repo-review-rules-and-ignored-paths.json",
 "api_version": "v1"
}