Skip to content

add Agents MD file - #298

Merged
osenan merged 20 commits into
mainfrom
claude_md@main
Oct 6, 2026
Merged

osenan merged 20 commits into
mainfrom
claude_md@main

Conversation

@osenan

@osenan osenan commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request

Closes #290
This PR is using a common structure for AGENTS.md and adding teal.code specific configuration. We are naming the file AGENTS.md and not CLAUDE.md as it will be available to all frameworks.

@github-actions

Copy link
Copy Markdown
Contributor


🎉 Thank you for your contribution! Before this PR can be accepted, we require that you read and agree to our Contributor License Agreement.
You can digitally sign the CLA by posting a comment on this Pull Request in the format shown below. This agreement will apply to this PR as well as all future contributions on this repository.


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


osenan seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@osenan

osenan commented Sep 24, 2026

Copy link
Copy Markdown
Contributor Author

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

@llrs-roche

Copy link
Copy Markdown
Contributor

@osenan the problem with the CLA is that the first commit is not tied to your account. You will need to rewrite the commit history to change the email to associate to your account.

@osenan
osenan marked this pull request as ready for review September 25, 2026 11:08
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  -------------
R/qenv-c.R                          55       0  100.00%
R/qenv-class.R                      13       0  100.00%
R/qenv-concat.R                      7       0  100.00%
R/qenv-constructor.R                 1       0  100.00%
R/qenv-errors.R                      4       4  0.00%    6-9
R/qenv-eval_code.R                  63       1  98.41%   40
R/qenv-extract.R                    30       0  100.00%
R/qenv-get_code.R                   24       0  100.00%
R/qenv-get_env.R                     3       1  66.67%   27
R/qenv-get_messages.r                5       0  100.00%
R/qenv-get_outputs.R                 6       0  100.00%
R/qenv-get_var.R                    13       1  92.31%   13
R/qenv-get_warnings.R                5       0  100.00%
R/qenv-join.R                        1       1  0.00%    13
R/qenv-length.R                      2       1  50.00%   2
R/qenv-show.R                       29      29  0.00%    19-50
R/qenv-within.R                      8       0  100.00%
R/utils-get_code_dependency.R      258       3  98.84%   160, 258, 326
R/utils.R                           42       0  100.00%
TOTAL                              569      41  92.79%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 04ce27c

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions

Copy link
Copy Markdown
Contributor

Unit Tests Summary

  1 files   14 suites   7s ⏱️
189 tests 185 ✅ 4 💤 0 ❌
273 runs  269 ✅ 4 💤 0 ❌

Results for commit e70a4fb.

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Unit Tests Summary

  1 files   14 suites   5s ⏱️
189 tests 185 ✅ 4 💤 0 ❌
273 runs  269 ✅ 4 💤 0 ❌

Results for commit 04ce27c.

♻️ This comment has been updated with latest results.

@llrs-roche llrs-roche left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I leave some comments below but I think the specific part for the package is too shallow. Isn't there something more deep that could guide better the AI? Like how we parse the code and extract calls to infer how an object is created, how we handle errors and warnings or how we join different qenvs.

Comment thread CLAUDE.Rmd Outdated
Comment thread vignettes/_AGENTS.Rmd Outdated
Comment thread CLAUDE.Rmd Outdated
Comment thread CLAUDE.Rmd Outdated
@llrs-roche

Copy link
Copy Markdown
Contributor

I noticed that AI (and humans) we fail to note the boundaries of the qenv: Defining a function outside the qenv and then using it inside one will fail. We need to bring in the function definition. This might not be practical or easy in some cases where the function is complex and have different helpers!

Comment thread vignettes/_AGENTS.Rmd
Co-authored-by: Lluís Revilla <185338939+llrs-roche@users.noreply.github.com>
Signed-off-by: Oriol Senan  <35930244+osenan@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
qenv_get_code 💚 $2.67$ $-1.31$ $0$ $0$ $0$ $0$

Results for commit b6d8f58

♻️ This comment has been updated with latest results.

@osenan osenan changed the title add claude MD file add Agents MD file Sep 29, 2026
@osenan

osenan commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

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

@osenan

osenan commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Hi @llrs-roche the changes are done. I added specific section about debugging qenv, it will be useful for debugging teal apps. The other comments I try to implement it as well.

Comment thread vignettes/_AGENTS.Rmd Outdated
Comment thread vignettes/_AGENTS.Rmd Outdated
@osenan
osenan requested a review from llrs-roche October 2, 2026 11:13

@llrs-roche llrs-roche left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I notice there is no CLAUDE.md file other than that the text looks good to me.

Try to fix the user.name or user.email on your setup as the CLA is failing.

@osenan

osenan commented Oct 2, 2026

Copy link
Copy Markdown
Contributor Author

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

@osenan

osenan commented Oct 2, 2026

Copy link
Copy Markdown
Contributor Author

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

Comment thread .Rbuildignore
@osenan

osenan commented Oct 5, 2026

Copy link
Copy Markdown
Contributor Author

recheck

@osenan
osenan enabled auto-merge (squash) October 6, 2026 13:45
@osenan
osenan merged commit 95c966e into main Oct 6, 2026
29 of 30 checks passed
@osenan
osenan deleted the claude_md@main branch October 6, 2026 13:48
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLAUDE.md

3 participants