-
Notifications
You must be signed in to change notification settings - Fork 2k
Add comprehensive AGENTS.md agent guide #2295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive agent-facing guide (AGENTS.md) that documents repository layout, workflows, and exact commands for AI agents and contributors working with this Node.js Docker image repository.
- Establishes standardized workflows for Node.js version updates, Docker builds, and documentation maintenance
- Documents project structure, coding standards, and testing procedures to ensure consistency
- Provides clear safety guidelines and permission boundaries for different types of repository operations
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
I've submitted PR #2296 to address the Markdown link check failure in CI. |
94b28e7 to
3a68563
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I won't block this, but I'm -1. I've found the co-pilot reviews to just be noise that add no value. For our generated PRs, it takes less time for a reviewer to flip to the Files tab and look at the changes, then request Co-Pilot to guess.
It has also suggested a user "fix" something historical that actually broke the images and needed to be reverted.
Introduce an agent-facing guide documenting repository layout, CI-aligned workflows, and required commands. Generated mainly by codex-cli v0.46.0 with gpt-5-codex (high) and the AGENTS.md construction prompt: - https://gist.github.com/PeterDaveHello/f30c38a156982a35683edfd5ece2d474 Reference: - https://agents.md/
3a68563 to
7cd1ccd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
@nschonni I see your point, and I agree that AI code review still has some limitations and even hallucinations. That said, another key purpose of AGENTS.md is to give us a way to use AI agents to assist with future updates to this project. Since the project is basically maintained by volunteers and there are some pending issues to handle later, this could help ease both the workload and mental effort. As tools and LLMs continue to improve, some of these challenges will gradually be resolved. That's the idea behind adding AGENTS.md. |
|
If you rebase your branch on |
Add AGENTS.md: an agent‑facing guide for this repository that documents layout, workflows, and the exact commands agents should run.
Generated mainly by codex-cli v0.46.0 with gpt-5-codex (high) and this AGENTS.md construction prompt:
Reference:
Motivation and Context
Establish a dedicated, machine‑consumable reference so agents can act
consistently and safely:
Testing Details
surfaces the corrected commands and coverage.
ensure parity for shfmt/shellcheck/doctoc/markdown‑link‑check.
Types of changes
Checklist
Summary from GitHub Copilot