Skip to content

chore: enable package-comments linter with exceptions for existing violations#1720

Closed
G-Rath wants to merge 1 commit intogoogle:mainfrom
ackama:lint/ensure-packages-comments
Closed

chore: enable package-comments linter with exceptions for existing violations#1720
G-Rath wants to merge 1 commit intogoogle:mainfrom
ackama:lint/ensure-packages-comments

Conversation

@G-Rath
Copy link
Copy Markdown
Collaborator

@G-Rath G-Rath commented Mar 18, 2025

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

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.51%. Comparing base (95d840a) to head (9cb7314).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@cuixq
Copy link
Copy Markdown
Contributor

cuixq commented Apr 2, 2025

I think the linter is doing its work - we need to add comments to these packages.

@G-Rath
Copy link
Copy Markdown
Collaborator Author

G-Rath commented Apr 3, 2025

@cuixq yup that's the next step - I'm going to be working on that in the background, but its currently a low priority

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 2, 2025

This pull request has not had any activity for 60 days and will be automatically closed in two weeks

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Jun 2, 2025
@G-Rath
Copy link
Copy Markdown
Collaborator Author

G-Rath commented Jun 2, 2025

not stale, just have not gotten around to it yet 😅

@G-Rath G-Rath added backlog Important but currently unprioritized and removed stale The issue or PR is stale and pending automated closure labels Jun 2, 2025
@G-Rath G-Rath force-pushed the lint/ensure-packages-comments branch from b69082f to 05091e7 Compare July 7, 2025 19:25
@G-Rath G-Rath marked this pull request as draft July 10, 2025 00:29
@G-Rath G-Rath force-pushed the lint/ensure-packages-comments branch 2 times, most recently from f1ce24d to 544740d Compare July 17, 2025 00:40
@G-Rath G-Rath force-pushed the lint/ensure-packages-comments branch from 544740d to 9cb7314 Compare July 17, 2025 00:40
@G-Rath G-Rath requested a review from jess-lowe July 17, 2025 00:45
@G-Rath G-Rath changed the title chore: explicitly allow linting errors from package-comments chore: enable package-comments linter with exceptions for existing violations Jul 17, 2025
@G-Rath G-Rath marked this pull request as ready for review July 17, 2025 00:46
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>
@G-Rath G-Rath deleted the lint/ensure-packages-comments branch July 21, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backlog Important but currently unprioritized

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants