Replies: 8 comments
|
Looks fine to me. I was thinking of adding an "I actually read it" line, but that might short-lived. For my own stuff, agentic dev usually goes well as long as you have it hooked into the tests, which we should be doing anyway. |
|
This is a great start to this! Even if incomplete, we should have something in place. Will think more about this soon. |
|
Adding the netcdf AI policy as an example which could be considered here as well: |
|
If you want a broader list, this might be useful (though overwhelming): https://github.com/melissawm/open-source-ai-contribution-policies This section on agentic AI from the Scientific Python Development Guide might also be of interest: https://learn.scientific-python.org/development/guides/ai/ FWIW, the "Extractive Contributions" section of the netCDF AI guidelines was what prompted Ryan to share that with me. I'm not sure it's exactly right for our projects, but hits on some concerns of mine. And it looks like GitHub is working on some features to help address related issues: https://github.blog/open-source/maintainers/how-pull-request-limits-are-cutting-down-the-noise/ |
|
I think adding a lightweight checklist now (holoviews-style) makes sense — cheap to add, easy to revise. Given how fast this space moves, I'd treat the wording as a living doc rather than something to get "right" upfront. Can revisit in a few months once we see how it plays out in practice. |
|
@rajeeja 's suggestion makes sense to me. Start with adding an AI disclosure into PR checklist, which can be something in between xarray's and holoviews' (Would asking about the exact AI tool and prompts as in xarray's be discouraging for contributors?). I'd also find it useful to have a pretty lightweigt AI policy doc in our repo that could be referred to from within the PR disclosure (Something like xarray's or maybe even lighterweight). |
|
I do think asking about the exact AI tool would be discouraging, and asking about prompts used would be especially discouraging. It's much easier to say "Claude" than to look up / recall which versions of Claude were used. I'm sure it would also take me a while to figure out what version of Github Copilot I'm using. Maybe we could just ask for tools used (e.g. "Claude, Github Copilot") and say "please include model number if you know it, e.g. Claude + Opus 4.6" but not require the version numbers if they aren't known? Asking for prompts used would be especially discouraging; some prompts are multi-paragraphs of context and some are me asking probably-silly questions that I don't necessarily want everyone to know I didn't know the answer to beforehand. Also, I have no idea how I would say what the prompts are for Github Copilot's inline completions…. I do think it's not asking too much to require a brief description of how the tools were used though, similarly to what holoviews is doing. Thank you for opening an issue on this - seeing that github didn't mention it automatically in this discussion, I'm putting a reference to it here: #1630 |
|
Asking for prompts would be pretty discouraging, I keep mine super casual so I'd be put off personally. Also, if you have claude commit, rather than commiting yourself, it will stamp it with the model name and number in the commit message. |
Uh oh!
There was an error while loading. Please reload this page.
Should uxarray have an AI Usage Policy? Also, should uxarray add an AI Usage Disclosure section or checklist item to the default github PR form template? (See also some recent work to improve that form: #1608)
There are many good examples online already. Pasting some of them below to help provide an easier starting point for discussion.
Example: xarray
xarray added an AI usage policy a few months ago (pydata/xarray#11126), as well as a section on the PR form:
Example: numpy
numpy's PR form includes:
Example: holoviews
holoviews PR form includes the following:
All reactions