docs: Update AGENTS.md #18
Conversation
Completed Working on "Auto PR Description"✅ Workflow completed successfully. |
Completed Working on "Code Review"✅ Workflow completed successfully. |
![overcut-ai[bot]](https://avatars.githubusercontent.com/in/1367736?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review summary
- Findings: 0 BLOCKER / 0 CRITICAL / 1 MAJOR / 0 MINOR / 0 SUGGESTION / 0 PRAISE
- Key theme: The AGENTS.md updates misrepresent the
releaseBeta.ymlworkflow as running the full lint → test → build → semantic-release pipeline even though the actual automation only bumps the version and performsnpm publish --tag beta. - Next steps: Update AGENTS.md to explain that
releaseBeta.ymlis a manual npm publish flow, call out the exact steps it performs, and describe any lint/test/build gates that must be run manually before triggering it.
Once the documentation accurately reflects the existing beta workflow (or the workflow is updated to match the description), this PR should be ready to merge.
| - `tsconfig.build.json` excludes `*.spec.ts` to keep published package clean. | ||
| - **Workflow awareness:** | ||
| - `ci.yml` enforces install → lint → test:cov → build. | ||
| - `release.yml` / `releaseBeta.yml` drive semantic-release jobs; local releases should mimic their command sequences. |
There was a problem hiding this comment.
[MAJOR]: Lines 42-43/55/92/99 describe releaseBeta.yml as a semantic-release pipeline that mirrors the lint → test → build gates, but the actual workflow (releaseBeta.yml) only bumps the version and runs npm publish --tag beta with no lint/test/build or semantic-release step. This misguides contributors about the validations performed before a beta publish.
Suggested fix: Document that releaseBeta.yml is a manual npm publish flow (version bump + npm publish) and explicitly call out any local lint/test/build steps that must be run manually before invoking it.
Summary
Adds the newly generated AGENTS.md guide so future AI contributors understand the repository layout, tooling, and contribution expectations.
Changes
Summary
This PR introduces a dedicated `AGENTS.md` guide to onboard AI contributors working in `@amplication/opentelemetry-nestjs`. The document details the repository layout, tooling expectations, coding standards, and reference workflows so agents can contribute consistently.
Changes
Commits
Testing