Skip to content

docs: add AGENTS.md with repo-specific agent guidance - #54

Draft
rkyanagimoto with Copilot wants to merge 6 commits into
mainfrom
copilot/generate-agents-md-file
Draft

rkyanagimoto with Copilot wants to merge 6 commits into
mainfrom
copilot/generate-agents-md-file

Conversation

Copilot AI commented Aug 6, 2026

Copy link
Copy Markdown

Summary

Adds a new AGENTS.md at the repository root to provide a single, repo-specific operating guide for coding agents.
It captures what an agent needs to contribute safely and consistently without re-deriving project conventions.

  • Scope

    • Introduces /AGENTS.md only (documentation change; no runtime/code-path impact).
  • Content added

    • Repository context (language/version, entrypoint, core packages, test layout).
    • Canonical local workflow commands from existing docs (go build, go fmt, golangci-lint, go test).
    • Change discipline for agents (minimal/surgical edits, test updates when behavior changes, avoid unrelated modifications).
    • Documentation + commit message expectations aligned with CONTRIBUTING.md.
    • Practical execution note to avoid Passenger-dependent e2e runs unless environment is present.
  • Excerpt

## Local Development Workflow

go build .
go fmt ./...
golangci-lint run
go test -v ./...

Related issue or URL

N/A

Self Checklist

  • go fmt ./... was done.
  • golangci-lint run ran with nothing warnings and errors.
  • go test -v ./... was all success.

Co-authored-by: rkyanagimoto <167505531+rkyanagimoto@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a repository-root AGENTS.md to centralize project-specific guidance for coding agents contributing to passenger-go-exporter, aiming to reduce re-discovery of conventions and improve consistency/safety of changes.

Changes:

  • Introduces an agent-focused repository overview (entrypoint, core packages, test layout).
  • Documents the canonical local workflow commands (build/format/lint/test) and coverage/e2e notes.
  • Captures contribution discipline and commit-message expectations aligned with existing docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Co-authored-by: rkyanagimoto <167505531+rkyanagimoto@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: rkyanagimoto <167505531+rkyanagimoto@users.noreply.github.com>
kyanagimoto and others added 2 commits August 6, 2026 15:30
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.

4 participants