|
| 1 | +# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +reviews: |
| 5 | + profile: chill |
| 6 | + high_level_summary: true |
| 7 | + high_level_summary_in_walkthrough: true |
| 8 | + poem: false |
| 9 | + auto_review: |
| 10 | + enabled: true |
| 11 | + drafts: false |
| 12 | + base_branches: |
| 13 | + - "^main$" |
| 14 | + - "^release/.*" |
| 15 | + - "^hotfix/.*" |
| 16 | + ignore_usernames: ["rapids-bot", "GPUtester", "nv-automation-bot", "copy-pr-bot"] |
| 17 | + tools: |
| 18 | + markdownlint: |
| 19 | + enabled: true |
| 20 | + shellcheck: |
| 21 | + enabled: true |
| 22 | + gitleaks: |
| 23 | + enabled: true |
| 24 | + sequence_diagrams: false |
| 25 | + collapse_walkthrough: true |
| 26 | + |
| 27 | + # Reduce noise from status messages |
| 28 | + request_changes_workflow: false |
| 29 | + review_status: false |
| 30 | + |
| 31 | + # Path-specific review instructions |
| 32 | + # Note: Detailed C++/CUDA and Python review guidelines are in cpp/REVIEW_GUIDELINES.md and python/REVIEW_GUIDELINES.md |
| 33 | + path_instructions: |
| 34 | + - path: "docs/**/*" |
| 35 | + instructions: | |
| 36 | + For documentation changes, focus on: |
| 37 | + - Accuracy: Verify code examples compile and run correctly |
| 38 | + - Completeness: Check if API changes (parameters, return values, errors) are documented |
| 39 | + - Clarity: Flag confusing explanations, missing prerequisites, or unclear examples |
| 40 | + - Consistency: Version numbers, parameter types, and terminology match code |
| 41 | + - Missing docs: If PR changes public APIs without updating docs, flag as HIGH priority |
| 42 | +
|
| 43 | + - path: "c/include/cuvs/**/*" |
| 44 | + instructions: | |
| 45 | + For public C API headers, additionally check: |
| 46 | + - Doxygen documentation for all public functions/classes |
| 47 | + - API changes flagged for docs/ updates |
| 48 | + - Breaking changes require deprecation warnings and migration guide updates |
| 49 | +
|
| 50 | + - path: "cpp/include/cuvs/**/*" |
| 51 | + instructions: | |
| 52 | + For public C++ API headers, additionally check: |
| 53 | + - Doxygen documentation for all public functions/classes |
| 54 | + - API changes flagged for docs/ updates |
| 55 | + - Breaking changes require deprecation warnings and migration guide updates |
| 56 | +
|
| 57 | + - path: "notebooks/**/*" |
| 58 | + instructions: | |
| 59 | + For example notebooks: |
| 60 | + - Verify code examples match current API (parameter names, return types) |
| 61 | + - Flag outdated imports or deprecated API usage |
| 62 | +
|
| 63 | + - path: "ci/**/*" |
| 64 | + instructions: | |
| 65 | + For CI/build scripts: |
| 66 | + - Check for proper conda environment handling |
| 67 | + - Verify GPU availability checks before tests |
| 68 | + - Check for proper error handling and meaningful error messages |
| 69 | +
|
| 70 | +knowledge_base: |
| 71 | + opt_out: false |
| 72 | + code_guidelines: |
| 73 | + filePatterns: |
| 74 | + - "cpp/REVIEW_GUIDELINES.md" |
| 75 | + - "python/REVIEW_GUIDELINES.md" |
| 76 | + - "docs/source/contributing.md" |
| 77 | + - "docs/source/developer_guide.md" |
0 commit comments