feat: add an AI page#821
Conversation
ericmjl
left a comment
There was a problem hiding this comment.
In general, really loving the policy! So many things resonate. I will be doing a series of blog posts on the weekend about scipy, including commentating on my thoughts on the use of AI in open source, and I think referencing this PR is going to be part of the story!
|
Something for the tips section, or a separate Patterns article we could reference from this one. I would recommend people add Architecture Design Records (ADRs) to projects where they use or support the use of Ai. They make explicit, design decisions that are often invisible or obscure in the code its self, and are beneficial to human contributors even in a world without Ai. Recommending from personal experience, I've seen major improvements in agent behavior using this strategy. I had Fable dig up some papers, review my own setup, and write this argument for their use with citations: 🤖 AI text below 🤖 There's early quantitative support that decision-record-style context is the kind that actually helps agents. A controlled study found agents complied with project decisions 46% of the time from code alone vs. 95% when decision records were retrievable — with the gap concentrated in decisions that aren't visible in the code arXiv:2605.08112. On SWE-bench Verified, tuned repository guidance lifted resolve rates from 25.5% to 33.0% (p<0.001), and the useful content was largely structural/architectural knowledge arXiv:2606.20512. Notably, a null-result study on AGENTS.md files found generic repo overviews don't help — but prescriptive instructions are followed arXiv:2602.11988. ADRs land on the right side of that split: decisions and constraints, not prose summaries. |
|
I've had Fable look at other 🤖 Details 🤖All three research agents are done. Here's the gap analysis against our three samples. What the samples already cover wellDisclosure with tool naming, "review and understand every line," the quality bar, the no-AI-co-author rule with the Gaps — things nearly every real policy has that our samples don't
Angles no sample covers (candidates for surrounding prose rather than the samples)
What I'd change, concretelyTo each sample, add three short lines: an autonomous-agent clause, scope covering issues/comments/review replies ("respond to reviewers yourself"), and a translation/grammar exception. Add a copyright-responsibility sentence to Moderate and Minimal, and a closure consequence to "All in". Then a short paragraph in the surrounding prose noting the security-report and reviewer-side angles with links to curl/Fedora/LLVM, and update the kernel trailer paragraph to cite the merged kernel doc plus the no- |
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Added tips for using AgentsView and Claude Code.
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Co-authored-by: Eric Ma <ericmjl@users.noreply.github.com>
Co-authored-by: Eric Ma <ericmjl@users.noreply.github.com> Co-authored-by: Lundy Bernard <lundybernard@users.noreply.github.com>
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Assisted-by: ClaudeCode:claude-fable-5 Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
c328c0b to
39d368e
Compare
Assisted-by: ClaudeCode:claude-fable-5 Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Assisted-by: ClaudeCode:claude-fable-5 Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
|
I'll let you (@lundybernard) add an ADR tip paragraph in a followup (or put it here and I'll paste it in). We probably can split this up and have more detailed tips in second page, but let's go with this for a first attempt (and keep tips to a paragraph each for now). I've worked on the page a bit, tightened it up with a few drop-downs, added some things other people put in their policies, and expanded the tips a bit. I'm pretty happy with it, if others are we can put it in. |
|
Oh, and I'm leaving any cookie updates (if there are any) for later. |
Assisted-by: ClaudeCode:claude-opus-5
|
Missed one of the links in #821 (comment), added it now. |
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Name a real project for each AI_POLICY.md level: the Linux kernel and CPython for all in, NumPy for moderate, and nvim-tree for minimal. Also add CPython to the other examples list. Assisted-by: ClaudeCode:claude-opus-5
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Fix #807.
This adds an AI page. Fitting to the theme, it was started by pointing Claude Opus at the issue and then reworked and added to (original output available in a comment on that issue).
There still are some things left to do:
AI_POLICY.mdprobably needs a proper human-written version for all three examples.AGENTS.md. I'd be biased toward not providing an AGENTS.md, but looking at the generated AGENTS.md and making sure it covers everything; anything it's missing we could add to the exisiting contribution guide, which should then show up in the AGENTS.md. But open to playing with this and other options. (Followup, and only if anything is needed)AI_POLICY.md, at least yet, and let projects select and modify their own.I'll also leave this open for a bit for reviews and suggestions.
📚 Documentation preview 📚: https://scientific-python-cookie--821.org.readthedocs.build/