docs: create agents.md - #5
Conversation
| ## Pull request (PR) process | ||
|
|
||
| - When opening a PR, use the request template (`.github/PULL_REQUEST_TEMPLATE.md`) and fill out all sections of the template in the PR description. | ||
| - Do not allow the developer to proceed with opening a PR if it does not fill out all sections of the template. | ||
| - Before a PR can be moved from draft to "ready for review", all of the relevant checklist items must be checked, and any | ||
| irrelevant checklist items should be crossed out. | ||
| - If code is AI-generated, the PR should be labeled `generated-by-AI`. There should be a brief, concise statement in the PR description of how AI was used in creating the PR (model used, high-level prompt intent, manual review confirmation). | ||
| - When new features, bug fixes, or other behavioral changes are introduced to the code, | ||
| unit tests must be added or updated to cover the new or changed functionality. | ||
| - If there are any API or other user-facing changes, the documentation must be updated via inline roxygen comments. | ||
| - The `tests` github actions workflow must pass before the PR can be approved. | ||
|
|
There was a problem hiding this comment.
@kelly-sovacool What happens if there are merge conflicts in code/MOSuite.
My understanding is that MOSuite repo has to be matched with syncweaver lock file. how would you resolve?
There was a problem hiding this comment.
I would want human devs to resolve merge conflicts rather than hand that responsibility off to AI agents.
| IMAGE=${IMAGE//codeocean/nciccbr} | ||
| echo "Using image: $IMAGE" | ||
|
|
||
| podman run --rm \ |
There was a problem hiding this comment.
@phoman14 thought you'd be interested in this. Providing a script for running the tests via podman solves dependency problems in local R environments! I also added a similar script for running R CMD Check in MOSuite (https://github.com/CCBR/MOSuite/blob/54ad1f43848029fc3f694783b3381f77a9d406fc/inst/extdata/run-check-podman.sh).
There was a problem hiding this comment.
This is interesting!! does this mean we can set up an R enviroment for everyone to use when testing even when they are testing locally?
There was a problem hiding this comment.
Yes, this script parses the code ocean environment json file to grab the docker image, and uses podman to run the tests in the image. The container engine has to be podman rather than docker since we can't install docker on our NCI laptops.
There was a problem hiding this comment.
I will try to get it set up on my computer and let you know if i run into any problems
2 participants
Changes
Issues
NA
PR Checklist
(
Strikethroughany points that are not applicable.)CHANGELOG.mdwith a short description of any user-facing changes and reference the PR number. Follow the style described in https://style.tidyverse.org/news.htmltestworkflow succeeds on the latest commit.