feat: Add note and imgs for ignore reason CF-1973 #2518
Conversation
|
Overall readability score: 52.74 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation for the issue ignore feature by adding information about selecting ignore reasons and including visual guidance through screenshots.
Key Changes:
- Added documentation about selecting reasons when ignoring issues
- Included example ignore reasons that match the UI menu options
- Replaced single screenshot with three new images showing the complete workflow
Reviewed Changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| submodules/chart | Updated submodule commit reference |
| docs/repositories/issues.md | Added ignore reason selection documentation and workflow screenshots |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
og-pixel
force-pushed
the
feat/CF-1973-ignore-reason
branch
from
1331114 to
e5a0945
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Use the options in the menu of each issue to: | ||
|
|
||
| - **Ignore the issue** and hide it from the list. | ||
| - **Select reason** for ignoring the issue. |
There was a problem hiding this comment.
The nested bullet point under 'Ignore the issue' creates an inconsistent structure. The sub-bullet 'Select reason' appears to be at the same level as the subsequent explanation, but it should either be part of the main bullet text or removed since the explanation already covers this functionality in line 71.
| - **Select reason** for ignoring the issue. |
| - Your team won't tackle the issues in the immediate future | ||
| - The issue isn't relevant in the specific context of your code | ||
| - The issue is a false positive | ||
| - The issue is test code |
There was a problem hiding this comment.
[nitpick] This reason appears in a list of 'because' clauses but doesn't follow the same grammatical structure as the others. The previous items describe situations ('won't tackle', 'isn't relevant', 'is a false positive'), but this one describes what the code is. Consider revising to maintain parallel structure, e.g., 'The issue is in test code' or 'The code is used only for testing'.
| - The issue is test code | |
| - The issue is in test code |
👀 Live preview
🚧 To do
Added a sentence regarding selecting "reason" for ignoring.
Added potential reason for ignoring (aligned with the menu options).
Added screenshots showing how to do it, and how it looks afterwads