Skip to content

docs: add AGENTS.md with contribution guidelines for AI agents - #91

Open
vincefn wants to merge 3 commits into
mainfrom
docs/add-agents-md
Open

docs: add AGENTS.md with contribution guidelines for AI agents#91
vincefn wants to merge 3 commits into
mainfrom
docs/add-agents-md

Conversation

@vincefn

@vincefn vincefn commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

What problem does this PR address?

Adds an AGENTS.md file that documents contribution policies for AI coding agents working on this repository, covering:

  • The dependency chain (vincefn/objcryst → diffpy/libobjcryst → pyobjcryst)
  • Branching and commit conventions
  • The scikit-package news-item requirement before opening a PR
  • CI checks on PRs
  • The requirement that PRs are always reviewed by a human before merge

What should the reviewer(s) do?

Review and merge.

vincefn and others added 3 commits July 28, 2026 13:03
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@vincefn

vincefn commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator Author

@sbillinge et al, I'm beginning to rely a lot on AI to manage projects, so I think an AGENTS.md file would be a useful addition. Feel free to amend/simplify as you prefer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant