asafm commented on PR #25871: URL: https://github.com/apache/pulsar/pull/25871#issuecomment-4542933157
@lhotari Couple of high level notes first: 1. From what I know, it's best to have a dedicated folder for agent documentation (e.g. `.ai`) and place any LLM agent instructions there. 2. Once you have (1), you can split the context per what is needed - everything related to contributing (setting up local dev env, rules for PR creation ,etc) goes to `CONTRIBUTING.md`; Architecture and how Pulsar works can go to ARCHITECTURE.md, and coding guidelines and best practices can go to `CODING.md`. 3. Once you have (2) `AGENTS.md` is effectively an index - describing the different LLM doc files you created in (2), and where they are located. 4. Once you have (3), all is left is to have the files for other LLMs be a symlink to `AGENTS.md` so , `github-instructions.md` and `CLAUDE.md` is just symlink. -- 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]
