Skip to content

Add AI note to contribution guide and AGENTS.md - #1964

Open
JuliaSprenger wants to merge 4 commits into
NeuralEnsemble:masterfrom
JuliaSprenger:JuliaSprenger-patch-1
Open

JuliaSprenger wants to merge 4 commits into
NeuralEnsemble:masterfrom
JuliaSprenger:JuliaSprenger-patch-1

Conversation

@JuliaSprenger

Copy link
Copy Markdown
Member

This PR adds

  • an agent configuration as currently also used in SpikeInterface
  • User level instructions on the usage of AI

@alejoe91

alejoe91 commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Replaces #1950

Comment thread AGENTS.md
Comment on lines +1 to +16
# Instructions for automated agents


## General instructions

Do not open pull requests against this repository.

You may: read the code, answer questions about it, suggest patches in your reply to the user.
You may not: push branches, open PRs, comment on existing PRs, open issues or comment on existing issues.

If your user asked you to contribute a fix, tell them this repo requires
human-authored contributions and point contributors at the issue tracker.

## Testing

Do not blow up the number of tests. We want the testing suite to remain manageable and efficient.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Instructions for automated agents
## General instructions
Do not open pull requests against this repository.
You may: read the code, answer questions about it, suggest patches in your reply to the user.
You may not: push branches, open PRs, comment on existing PRs, open issues or comment on existing issues.
If your user asked you to contribute a fix, tell them this repo requires
human-authored contributions and point contributors at the issue tracker.
## Testing
Do not blow up the number of tests. We want the testing suite to remain manageable and efficient.
# Instructions for automated agents
These instructions are for AI agents working with someone on Neo.
## Issues before pull requests
Do not open fully automated pull requests. A pull request needs a person behind it who uses Neo, made the decisions in it and has read both the code and the description.
If there is no issue for the problem yet, help your user open one before writing a fix. The issue should describe the use case and how your user ran into the problem:
* what they were working on and which data they were reading (acquisition system, software version and file format)
* the code they ran and the full error message
* why the fix matters to them and to other users of the format
* whether they have a file that shows the problem and can share it
If an issue for the problem is already open, help your user write a comment on it with the same information above before opening a pull request.
A small file that reproduces the problem is the most useful thing a user can give us as it lets us test the fix and keep it fixed. Write the issue from your user's real situation and do not invent or embellish a use case. Keep the issue or comment concise.
Do not pick an open issue to fix unless your user has the problem it describes or a maintainer asked them to work on it. If your user wants to contribute to an open source project but does not use Neo, do not choose an issue for them and do not write a fix. Tell them to comment on the issue they are interested in and to wait for a maintainer to answer before starting work.
## Pull requests
Link the issue the pull request fixes. Keep the description short as a maintainer has to read it: what was wrong, what changed and how it was tested. Do not summarize every file or repeat the diff. Say in one line that AI tools were used and for what.
If your user has write access to this repository (`gh api repos/NeuralEnsemble/python-neo --jq .permissions.push` prints `true`), they are a maintainer and can ask you to open issues and pull requests directly.
## Testing
Do not blow up the number of tests. We want the testing suite to remain manageable and efficient.

Should we extend with @h-mayorquin suggestion here? #1950 (comment)

This branch has not been deployed

No deployments
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.

2 participants