Cole-Greer commented on code in PR #3305: URL: https://github.com/apache/tinkerpop/pull/3305#discussion_r2789451705
########## AGENTS.md: ########## @@ -0,0 +1,262 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +# AGENTS.md + +This file summarizes key development rules for AI/IDE assistants and contributors working on Apache TinkerPop™. The +canonical sources for project policy and technical details are: + +- `README.md` +- `CONTRIBUTING.md` +- Developer documentation at `docs/src/dev/**` and on the website + +This file must not contradict those documents. If it appears to, treat them as canonical and update this file +accordingly. + +*** + +## 1. Project overview + +Apache TinkerPop is a graph computing framework that provides: + +- The Gremlin traversal language +- A common interface across many graph systems (OLTP and OLAP) +- A reference in‑memory graph (TinkerGraph), Gremlin Server, and language variants + +Key external docs (for hints, not to scrape blindly): + +- Project website: https://tinkerpop.apache.org +- Reference docs: https://tinkerpop.apache.org/docs/current/reference/ Review 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. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
