|
| 1 | +--- |
| 2 | +applyTo: '**/github-issues/**' |
| 3 | +--- |
| 4 | + |
| 5 | +# Guidelines for Creating Effective GitHub Issues |
| 6 | + |
| 7 | +## Issue Format |
| 8 | + |
| 9 | +When creating GitHub issues, use the following structure to ensure clarity and ease of verification: |
| 10 | + |
| 11 | +### For Bug Reports |
| 12 | + |
| 13 | +1. **Title**: Concise description of the issue (5-10 words) |
| 14 | + |
| 15 | +2. **Problem Statement**: |
| 16 | + |
| 17 | + - 1-2 sentences describing the issue |
| 18 | + - Focus on user impact |
| 19 | + - Use clear, non-technical language when possible |
| 20 | + |
| 21 | +3. **Steps to Verify Fix**: |
| 22 | + - Numbered list (5-7 steps maximum) |
| 23 | + - Start each step with an action verb |
| 24 | + - Include expected observations |
| 25 | + - Cover both success paths and cancellation/back button scenarios |
| 26 | + |
| 27 | +### For Feature Requests |
| 28 | + |
| 29 | +1. **Title**: Clear description of the requested feature |
| 30 | + |
| 31 | +2. **Need Statement**: |
| 32 | + |
| 33 | + - 1-2 sentences describing the user need |
| 34 | + - Explain why this feature would be valuable |
| 35 | + |
| 36 | +3. **Acceptance Criteria**: |
| 37 | + - Bulleted list of verifiable behaviors |
| 38 | + - Include how a user would confirm the feature works as expected |
| 39 | + |
| 40 | +## Examples |
| 41 | + |
| 42 | +### Bug Report Example |
| 43 | + |
| 44 | +``` |
| 45 | +# Terminal opens prematurely with PET Resolve Environment command |
| 46 | +
|
| 47 | +**Problem:** When using "Resolve Environment..." from the Python Environment Tool menu, |
| 48 | +the terminal opens before entering a path, creating a confusing workflow. |
| 49 | +
|
| 50 | +**Steps to verify fix:** |
| 51 | +1. Run "Python Environments: Run Python Environment Tool in Terminal" from Command Palette |
| 52 | +2. Select "Resolve Environment..." |
| 53 | +3. Verify no terminal opens yet |
| 54 | +4. Enter a Python path |
| 55 | +5. Verify terminal only appears after path entry |
| 56 | +6. Try canceling at the input step - confirm no terminal appears |
| 57 | +``` |
| 58 | + |
| 59 | +### Feature Request Example |
| 60 | + |
| 61 | +``` |
| 62 | +# Add back button support to multi-step UI flows |
| 63 | +
|
| 64 | +**Problem:** The UI flows for environment creation and Python project setup lack back button |
| 65 | +functionality, forcing users to cancel and restart when they need to change a previous selection. |
| 66 | +
|
| 67 | +**Steps to verify implementation:** |
| 68 | +1. Test back button in PET workflow: Run "Python Environments: Run Python Environment Tool in Terminal", |
| 69 | + select "Resolve Environment...", press back button, confirm it returns to menu |
| 70 | +2. Test back button in VENV creation: Run "Create environment", select VENV, press back button at various steps |
| 71 | +3. Test back button in CONDA creation: Create CONDA environment, use back buttons to navigate between steps |
| 72 | +4. Test back button in Python project flow: Add Python project, verify back functionality in project type selection |
| 73 | +``` |
| 74 | + |
| 75 | +## Best Practices |
| 76 | + |
| 77 | +1. **Be concise**: Keep descriptions short but informative |
| 78 | +2. **Use active voice**: "Terminal opens prematurely" rather than "The terminal is opened prematurely" |
| 79 | +3. **Include context**: Mention relevant commands, UI elements, and workflows |
| 80 | +4. **Focus on verification**: Make steps actionable and observable |
| 81 | +5. **Cover edge cases**: Include cancellation paths and error scenarios |
| 82 | +6. **Use formatting**: Bold headings and numbered lists improve readability |
| 83 | + |
| 84 | +Remember that good issues help both developers fixing problems and testers verifying solutions. |
0 commit comments