Skip to content

docs: add AI coding agent developer guide - #4

Open
hajnalmt wants to merge 1 commit into
masterfrom
agents/volcano-with-agents
Open

docs: add AI coding agent developer guide#4
hajnalmt wants to merge 1 commit into
masterfrom
agents/volcano-with-agents

Conversation

@hajnalmt

Copy link
Copy Markdown
Owner

Summary

  • Adds AGENTS.md with a comprehensive developer guide for AI coding agents working on the Volcano codebase
  • Covers build commands, testing, code style guidelines (imports, naming, error handling, comments, formatting), code generation, commit message format, linter configuration, and key directory structure
  • Updates .gitignore accordingly

Motivation

Providing AI coding agents with structured project context enables them to produce code that follows Volcano's conventions consistently, reducing review friction and improving contribution quality.

@hajnalmt
hajnalmt force-pushed the agents/volcano-with-agents branch from 1e0cac5 to c4fbe5a Compare February 19, 2026 15:16
@hajnalmt

Copy link
Copy Markdown
Owner Author

@codex What do you think?

@chatgpt-codex-connector

Copy link
Copy Markdown

To use Codex here, create an environment for this repo.

@hajnalmt

Copy link
Copy Markdown
Owner Author

done please try again.
@codex

@chatgpt-codex-connector

Copy link
Copy Markdown

Summary

  • Added a new Pull Request Follow-Up Workflow section to AGENTS.md with a 5-step process for handling comment-triggered iteration (trigger-first reading, latest review/CI validation, incremental updates, scoped validation, and clear reporting). AGENTS.mdL400-L412
  • Updated .gitignore to ignore local Codex environment metadata under .codex/, reducing risk of accidental commits from local setup files. .gitignoreL147-L148

Testing

  • git diff --check
  • git status --short
  • git commit -m "docs: clarify PR follow-up workflow for agents" -m "Add a short follow-up workflow section to AGENTS.md so Codex-style\ncomment triggers are handled consistently with current CI and review\ncontext. Also ignore local .codex metadata directories to prevent\naccidental commits from environment setup steps.\n\nFixes #N/A"

View task →

@hajnalmt
hajnalmt force-pushed the agents/volcano-with-agents branch 2 times, most recently from 09cbeda to e3709cb Compare February 19, 2026 16:03
@hajnalmt
hajnalmt force-pushed the agents/volcano-with-agents branch 2 times, most recently from d0dc93f to 8531cd6 Compare May 18, 2026 14:03
This adds AGENTS.md to provide AI coding agents with essential
information about the Volcano codebase including build commands,
testing, code style guidelines, project conventions, and
comprehensive agent-scheduler documentation covering its
architecture, plugin/action interfaces, sharding model, and
the agent node daemon.

Signed-off-by: Hajnal Máté <hajnalmt@gmail.com>
@hajnalmt
hajnalmt force-pushed the agents/volcano-with-agents branch from 8531cd6 to 0cf3dfd Compare May 26, 2026 12:11
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