chore: enable package-comments linter with exceptions for existing violations
#1720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1720 +/- ##
==========================================
+ Coverage 67.50% 67.51% +0.01%
==========================================
Files 172 172
Lines 16242 16242
==========================================
+ Hits 10964 10966 +2
+ Misses 4603 4601 -2
Partials 675 675 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
hogo6002
approved these changes
Mar 18, 2025
|
I think the linter is doing its work - we need to add comments to these packages. |
|
@cuixq yup that's the next step - I'm going to be working on that in the background, but its currently a low priority |
|
This pull request has not had any activity for 60 days and will be automatically closed in two weeks |
github-actions
bot
added
the
stale
|
not stale, just have not gotten around to it yet 😅 |
G-Rath
added
backlog
G-Rath
force-pushed
the
lint/ensure-packages-comments
branch
from
b69082f to
05091e7
Compare
G-Rath
force-pushed
the
lint/ensure-packages-comments
branch
2 times, most recently
from
f1ce24d to
544740d
Compare
G-Rath
force-pushed
the
lint/ensure-packages-comments
branch
from
544740d to
9cb7314
Compare
G-Rath
changed the title
package-commentspackage-comments linter with exceptions for existing violations
another-rex
added a commit
that referenced
this pull request
Jul 18, 2025
Spent a bit of time to just add comments to all the offending packages. Closes: #1720 --------- Co-authored-by: Gareth Jones <jones258@gmail.com> Co-authored-by: Xueqin Cui <72771658+cuixq@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While it looks ugly, this means new packages will have to pass this lint and we can chip away at the existing ones rather than having to deal with them all at once