Skip to content

Commit f6154fd

Browse files
committed
Updated AGENTS.md
1 parent 63423a9 commit f6154fd

1 file changed

Lines changed: 26 additions & 18 deletions

File tree

AGENTS.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,23 @@ These notes apply to this repository root and the `RcppTskit/` package.
1515
* We keep local quality gates green before handoff.
1616
* We update `RcppTskit/NEWS.md` for user-visible behavior or API changes.
1717

18+
## Permission
19+
20+
You can use all the commands and tools mentioned in this document,
21+
both for sandboxed and unsandboxed/escalated execution.
22+
You don't need to ask for permission to use these commands and tools,
23+
for the purposes described here.
24+
1825
## Definition of done
1926

2027
A task is done when all applicable items below are completed:
2128

2229
* Added/updated user-facing examples and tests for new functionality.
2330
* `pre-commit run --all-files` to pass basic code checks.
24-
* `Rscript -e "setwd('RcppTskit'); devtools::test()"` for interactive "mode" testing.
25-
* `Rscript -e "setwd('RcppTskit'); devtools::check()"` for non-interactive "mode" testing and full package checks.
31+
* `Rscript -e "setwd('RcppTskit'); devtools::test()"`
32+
for interactive "mode" testing.
33+
* `Rscript -e "setwd('RcppTskit'); devtools::check()"`
34+
for non-interactive "mode" testing and full package checks.
2635
* Updated `RcppTskit/NEWS.md` for user-visible changes.
2736

2837
## Quality toolchain
@@ -144,14 +153,6 @@ Run slower package checks from the package directory:
144153
Rscript -e "setwd('RcppTskit'); devtools::check()"
145154
```
146155

147-
### Permission
148-
149-
The user explicitly allows unsandboxed/escalated execution for:
150-
151-
- `Rscript -e "setwd('RcppTskit'); devtools::test()"`
152-
- `Rscript -e "setwd('RcppTskit'); devtools::check(vignette = FALSE)"`
153-
- `Rscript -e "setwd('RcppTskit'); devtools::check()"`
154-
155156
### Codex runner caveat: build-tools detection
156157

157158
In the sandboxed agent runner, `devtools::check()` may fail early with:
@@ -192,14 +193,21 @@ We strive for very good testing with `testthat`.
192193

193194
- Add or update `testthat` tests for every behavior change.
194195
- Prefer focused regression tests for bug fixes.
195-
- Keep tests runnable via package checks (`devtools::check()`).
196-
- Guard environment-dependent tests with explicit skips (for example Python
197-
availability, network availability, and CRAN restrictions).
196+
- Keep tests runnable via package tests and checks.
197+
- Guard environment-dependent tests with explicit skips
198+
(for example Python availability, network availability, and CRAN restrictions).
199+
200+
For testing use:
201+
- `Rscript -e "setwd('RcppTskit'); devtools::test()"`
202+
for interactive "mode" testing, or variants of this one, such as
203+
`Rscript -e "setwd('RcppTskit'); devtools::test(filter = 'TableCollection')`.
198204

199-
### Permission
205+
Tests are also run as part of R CMD check.
200206

201-
The user explicitly allows unsandboxed/escalated execution for:
207+
## Changing files
202208

203-
- `Rscript -e "setwd('RcppTskit'); devtools::test()"` or
204-
variants of this one, such as
205-
`Rscript -e "setwd('RcppTskit'); devtools::test(filter = 'TableCollection')`
209+
You have permission to change files,
210+
but note that others might be working with the files in this repository at the same time,
211+
so don't tweak or revert changes done by others.
212+
Keep track of which files you are changing and focus on those changes only.
213+
If there are conflicting edits, try to merge or ask for advice on how to merge.

0 commit comments

Comments
 (0)