|
| 1 | +instructions: | |
| 2 | + Apply the minimal set of labels that accurately characterize the issue/PR: |
| 3 | + - Use at most 1-2 labels unless there's a compelling reason for more |
| 4 | + - Prefer specific labels (bug, feature) over generic ones (question, help wanted) |
| 5 | + - For PRs that fix bugs, use 'bug' not 'enhancement' |
| 6 | + - Never combine: bug + enhancement, feature + enhancement. For these labels, only choose the most relevant one. |
| 7 | + - Reserve 'question' and 'help wanted' for when they're the primary characteristic |
| 8 | +
|
| 9 | +labels: |
| 10 | + - bug: |
| 11 | + description: "Something isn't working as expected" |
| 12 | + instructions: | |
| 13 | + Apply when describing or fixing unexpected behavior: |
| 14 | + - Issues: Clear error messages or unexpected outcomes |
| 15 | + - PRs: Fixes for broken functionality |
| 16 | + Don't apply enhancement/feature for bug fixes unless they add significant new functionality |
| 17 | + beyond fixing the bug |
| 18 | +
|
| 19 | + - documentation: |
| 20 | + description: "Improvements or additions to documentation" |
| 21 | + instructions: | |
| 22 | + Apply only when documentation is the primary focus: |
| 23 | + - README updates |
| 24 | + - Code comments and docstrings |
| 25 | + - API documentation |
| 26 | + - Usage examples |
| 27 | + Don't apply for minor doc updates alongside code changes |
| 28 | +
|
| 29 | + - enhancement: |
| 30 | + description: "Improvements to existing features" |
| 31 | + instructions: | |
| 32 | + Apply only for improvements to existing functionality: |
| 33 | + - Performance improvements |
| 34 | + - UI/UX improvements |
| 35 | + - Expanded capabilities of existing features |
| 36 | + Don't apply to: |
| 37 | + - Bug fixes |
| 38 | + - New features |
| 39 | + - Minor tweaks |
| 40 | +
|
| 41 | + - feature: |
| 42 | + description: "New functionality" |
| 43 | + instructions: | |
| 44 | + Apply only for net-new functionality: |
| 45 | + - New API endpoints |
| 46 | + - New commands or tools |
| 47 | + - New user-facing capabilities |
| 48 | + Don't apply to: |
| 49 | + - Improvements to existing features (use enhancement) |
| 50 | + - Bug fixes |
| 51 | +
|
| 52 | + - good first issue: |
| 53 | + description: "Good for newcomers" |
| 54 | + instructions: | |
| 55 | + Apply very selectively to issues that are: |
| 56 | + - Small in scope |
| 57 | + - Well-documented |
| 58 | + - Require minimal context |
| 59 | + - Have clear success criteria |
| 60 | + Don't apply if the task requires significant background knowledge |
| 61 | +
|
| 62 | + - help wanted: |
| 63 | + description: "Extra attention is needed" |
| 64 | + instructions: | |
| 65 | + Apply only when it's the primary characteristic: |
| 66 | + - Issue needs external expertise |
| 67 | + - Current maintainers can't address it |
| 68 | + - Additional contributors would be valuable |
| 69 | + Don't apply just because an issue is open or needs work |
| 70 | +
|
| 71 | + - question: |
| 72 | + description: "Further information is requested" |
| 73 | + instructions: | |
| 74 | + Apply only when the primary purpose is seeking information: |
| 75 | + - Clarification needed before work can begin |
| 76 | + - Architectural discussions |
| 77 | + - Implementation strategy questions |
| 78 | + Don't apply to: |
| 79 | + - Bug reports that need more details |
| 80 | + - Feature requests that need refinement |
| 81 | +
|
| 82 | +# These files will be included in the context if they exist |
1 | 83 | context-files:
|
2 | 84 | - README.md
|
| 85 | + - CONTRIBUTING.md |
| 86 | + - CODE_OF_CONDUCT.md |
| 87 | + - .github/ISSUE_TEMPLATE/bug_report.md |
| 88 | + - .github/ISSUE_TEMPLATE/feature_request.md |
0 commit comments