Skip to content

develop CLAUDE.md - #364

Merged
wangben718 merged 15 commits into
mainfrom
360-add-claudemd
Oct 2, 2026
Merged

wangben718 merged 15 commits into
mainfrom
360-add-claudemd

Conversation

@wangben718

Copy link
Copy Markdown
Contributor

Pull Request

Proposed Structure of AGENTS.md:

  • Header + role — one line on what the package is, its boundaries ("does NOT build apps / define modules / touch teal_data"), and a pointer to teal's AGENTS.md for ecosystem-wide rules.
  • Commands — exact, non-guessable invocations: load/document/test/check, single-test, lint/style, and pre-commit.
  • Gotchas & conventions — the heart: traps and guardrails with file references, including the silent TESTING_DEPTH test-skipping, base/grid plots being first-class (unlike the ecosystem "prefer ggplot2" rule), the webshot2 PDF-export dependency, and "add an S3 method, don't branch" for new table types.
  • Widget shape — the one non-derivable invariant: the _ui/_srv suffix convention (vs. teal's ui_/srv_ prefix).

Fixes #360

@wangben718 wangben718 linked an issue Sep 17, 2026 that may be closed by this pull request
@github-actions

github-actions Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

✅ All contributors have signed the CLA
Posted by the CLA Assistant Lite bot.

@github-actions

github-actions Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Unit Tests Summary

  1 files   17 suites   2m 12s ⏱️
182 tests 181 ✅ 0 💤 0 ❌ 1 🔥
424 runs  423 ✅ 0 💤 0 ❌ 1 🔥

For more details on these errors, see this check.

Results for commit 92b7b24.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
plot_with_settings_ui 💔 $53.62$ $+3.51$ $0$ $0$ $0$ $0$
table_with_settings 💚 $13.73$ $-4.03$ $-1$ $0$ $0$ $+1$
table_with_settings_ui 💔 $33.80$ $+2.07$ $0$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
table_with_settings 💚 $3.04$ $-1.74$ type_download_srv_table_downloading_gtsummary_output_types
table_with_settings 💚 $5.29$ $-1.59$ type_download_srv_table_downloading_tbl_split_output_types

Results for commit 549d002

♻️ This comment has been updated with latest results.

@llrs-roche

Copy link
Copy Markdown
Member

Let's put it on hold until we finish insightsengineering/nestdevs-tasks#121

@wangben718

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@llrs-roche

Copy link
Copy Markdown
Member

Hi, @wangben718 Even if it is not merged yet, could you follow the PR as in pharmaverse/teal.code#298, so that it inherits from a shared file and has a specific section tailored for this package? Try also to make it pass all checks on the CI.
Thanks!

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

badge

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  ------------------------------------------------------
R/basic_table_args.R             23       0  100.00%
R/draggable_buckets.R            87      12  86.21%   116-121, 151-156
R/get_dt_rows.R                  13       0  100.00%
R/ggplot2_args.R                 49       0  100.00%
R/nested_closeable_modal.R       20      20  0.00%    83-103
R/optionalInput.R               255      79  69.02%   190, 315-389, 402-409, 411-416, 434, 436, 501, 583-596
R/panel_group.R                  39       8  79.49%   72-79
R/plot_with_settings.R          310      16  94.84%   301-307, 329, 366, 375-376, 392, 580-581, 583, 585
R/standard_layout.R              52       4  92.31%   90-93
R/table_with_settings.R         259       6  97.68%   204, 429-433
R/utils.R                        19       0  100.00%
R/verbatim_popup.R              104      35  66.35%   112-113, 115, 123-154
R/white_small_well.R              7       0  100.00%
TOTAL                          1237     180  85.45%

Diff against main

Filename                   Stmts    Miss  Cover
-----------------------  -------  ------  -------
R/table_with_settings.R       +3       0  +0.03%
TOTAL                         +3       0  +0.04%

Results for commit: c28b1ca

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@llrs-roche llrs-roche self-assigned this Sep 28, 2026

@llrs-roche llrs-roche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes on R/*.R shouldn't be of that depth. Please if any change is needed there make your case with an issue and a different PR.

The content looks okay, it follows the agreed structure. I don't miss anything but at the same time I'm not sure if there are some unwritten rules for the package that I haven't heard of.

Comment thread R/table_with_settings.R Resolved
Comment thread AGENTS.Rmd Resolved
Comment thread AGENTS.Rmd Resolved
Comment thread AGENTS.Rmd Resolved
Comment thread vignettes/_AGENTS.Rmd Resolved
Comment thread AGENTS.Rmd Resolved
Comment thread AGENTS.Rmd Resolved
wangben718 and others added 6 commits September 28, 2026 12:42
Co-authored-by: Lluís Revilla <185338939+llrs-roche@users.noreply.github.com>
Signed-off-by: Bingjun(Benjamin) Wang <85646030+wangben718@users.noreply.github.com>
Co-authored-by: Lluís Revilla <185338939+llrs-roche@users.noreply.github.com>
Signed-off-by: Bingjun(Benjamin) Wang <85646030+wangben718@users.noreply.github.com>
Co-authored-by: Lluís Revilla <185338939+llrs-roche@users.noreply.github.com>
Signed-off-by: Bingjun(Benjamin) Wang <85646030+wangben718@users.noreply.github.com>
…) a temp filename with an extension"

This reverts commit 7fc130e.

@llrs-roche llrs-roche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only points left are the formal ones about where the file should be. Thanks!

Comment thread vignettes/_AGENTS.Rmd Resolved
Comment thread vignettes/_AGENTS.Rmd Resolved
@wangben718

Copy link
Copy Markdown
Contributor Author

Thanks @llrs-roche for the heads-up. I have moved the RMD file to vignettes folder.

@llrs-roche llrs-roche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I missed this previously but there is no CLAUDE.md file on this PR!! Add it before merging please

@wangben718

Copy link
Copy Markdown
Contributor Author

Sorry, I missed this previously but there is no CLAUDE.md file on this PR!! Add it before merging please

Here is the CLAUDE.md: https://github.com/insightsengineering/teal.widgets/pull/364/changes#diff-6ebdb617a8104a7756d0cf36578ab01103dc9f07e4dc6feb751296b9c402faf7

@wangben718
wangben718 merged commit eb9a989 into main Oct 2, 2026
28 of 30 checks passed
@wangben718
wangben718 deleted the 360-add-claudemd branch October 2, 2026 15:09
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 2, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLAUDE.md

2 participants