Added AGENTS.md #3305
Added AGENTS.md #3305
Conversation
|
I like this as a start. |
AGENTS.md
Outdated
| Key external docs (for hints, not to scrape blindly): | ||
|
|
||
| - Project website: https://tinkerpop.apache.org | ||
| - Reference docs: https://tinkerpop.apache.org/docs/current/reference/ |
There was a problem hiding this comment.
Nit: This might become more of a maintenance headache, but it may be preferable to pin these links to the latest release in the branch, instead of directing agents to docs which may contain new steps or unavailable features.
There was a problem hiding this comment.
i struggled a bit with what to do there - decided to change it to point to the local docs in the repo. that way it's always current. that didn't need to be the external url.
AGENTS.md
Outdated
| - Python: | ||
|
|
||
| ```bash | ||
| mvn clean install -Pglv-python |
There was a problem hiding this comment.
These GLV commands are arguably too heavy for building and testing GLVs. Might be best to instruct to build the server and dependencies once: mvn clean install -pl :gremlin-server -am -DskipTests and then only build and run the GLV afterwards mvn clean install -Pglv-python -pl :gremlin-python
There was a problem hiding this comment.
yeah...i didn't pay as close attention to that section as i should have. that was a bit of a direct copy/paste from my local setup and it never worked well. made some adjustments.
AGENTS.md
Outdated
| - Generate documentation: | ||
|
|
||
| ```bash | ||
| bin/process-docs.sh |
There was a problem hiding this comment.
Is this sufficient for agents to figure out the docs build process on their own? I would imagine they would at the very least need a reference to the documentation environment docs, and likely substantial hand-holding through the hadoop setup.
There was a problem hiding this comment.
deleted that. another section i didn't focus to heavily on and my tools never ever tried to use any of that. not even sure we're at a stage with these tools where we would use that. removed the section.
|
I left a few comments for your consideration. None of them are blockers, and I defer to your judgement on any resolution. VOTE +1 |
This is just an initial attempt at making the repository a bit more friendly to AI agents/tools. Moves README/CONTRIBUTING to markdown which is more standard that asciidoc for these things. Expanded the content of both of those files. AGENTS.md is meant to be generic to any AI agent/tool as TinkerPop isn't prescriptive in that regard. With AGENTS.md we at least have a centralized place for any tool to learn how to contribute here.
|
ended up choosing to delete the old asciidoc files - i don't think it's a big deal since they would be removed on |
3 participants
This is just an initial attempt at making the repository a bit more friendly to AI agents/tools. Moves README/CONTRIBUTING to markdown which is more standard that asciidoc for these things. Expanded the content of both of those files. AGENTS.md is meant to be generic to any AI agent/tool as TinkerPop isn't prescriptive in that regard. With AGENTS.md we at least have a centralized place for any tool to learn how to contribute here.
Purposefully targetted the 3.7-dev branch since we're still developing there. I'd expect this file to potentially be different between branches so the file is currently at a lowest common denominator right now. I'd imagine it will be different across branches to be most effective. I could see where over time we add more AGENTS.md files in the roots of various directories as well (each GLV would probably need one at a minimum).
Wasn't sure what to do with the old
.asciidocfiles. I think we would just delete on the merge tomasterand keep them on the 3.x lines. Open to other ideas, but i do think we'd be better with markdown for this stuff.Anyway, it's time to start somewhere. VOTE +1