Skip to content

docs: Update AGENTS.md#24

Open
overcut-ai[bot] wants to merge 6 commits intomainfrom
docs/update-agents-md-20260125
Open

docs: Update AGENTS.md#24
overcut-ai[bot] wants to merge 6 commits intomainfrom
docs/update-agents-md-20260125

Conversation

@overcut-ai
Copy link
Copy Markdown

@overcut-ai overcut-ai bot commented Jan 25, 2026

🔄 Overcut automatically updated AGENTS.md with latest repository analysis.

Release Summary

This documentation-only release refreshes the AGENTS guide so contributors—human or automated—have an authoritative playbook for working within @amplication/opentelemetry-nestjs. The expanded guide outlines the repository’s purpose, structure, coding standards, instrumentation patterns, and CI expectations to ensure consistent, safe contributions.

Highlights

  • Comprehensive AGENTS guide now describes repository purpose, key exports, and instrumentation behaviors
  • Clear directory-level reference table helps contributors locate relevant files quickly
  • Step-by-step development workflow mirrors CI to reduce validation drift
  • Detailed instrumentation and decorator patterns guide consistent tracing contributions
  • Critical rules and common task checklists prevent mistakes when modifying telemetry logic or docs

Features

  • Authoritative AGENTS Guide: Introduces a full-spectrum reference covering project overview, structure, development workflow, code patterns, and quality bars.
  • Instrumentation & Decorator Playbook: Documents default instrumentation coverage, decorator usage, trace utilities, and SDK helper patterns so changes stay aligned with tracing conventions.
  • Operational Checklists: Adds prescriptive sequences for running verification commands, extending instrumentation, updating docs, and adjusting SDK helpers.

Improvements

  • Centralized references to README, migration guides, CI workflows, and assets to minimize context switching for contributors.

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Jan 25, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Jan 25, 2026

Completed Working on "Code Review"

✅ Workflow completed successfully.


👉 View complete log

Copy link
Copy Markdown
Author

@overcut-ai overcut-ai bot left a comment

Choose a reason for hiding this comment

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

Findings: 2 MINOR (documentation mismatches).

Key themes:

  1. AGENTS.md overstates instrumentation test coverage—the console logger instrumentation lacks the documented co-located spec file.
  2. Quality standards mention strict TypeScript builds even though the tsconfig files are not configured for strict mode.

Next steps:

  • Either add the missing console logger spec or adjust the documentation to describe the existing coverage accurately.
  • Align the strict-build guidance with the actual tsconfig settings—enable strict mode or update the documentation to match current compiler flags.

Comment thread AGENTS.md
| --- | --- | --- |
| `src/` | Library source. `index.ts` re-exports the module, instrumentation providers, decorators, and SDK helpers. | TypeScript only; compilation output lives in `dist/` (generated via `nest build`). |
| `src/trace/decorators/` | Decorators such as [`span.ts`](src/trace/decorators/span.ts) and `traceable.ts`. | Decorators rely on metadata constants defined in `src/constants.ts`. |
| `src/trace/instrumentation/` | Instrumentation classes (e.g., [`controller.instrumentation.ts`](src/trace/instrumentation/controller.instrumentation.ts)) plus shared base classes and interfaces. | Every instrumentation has a co-located `.spec.ts` (Jest). |
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

[IMPORTANCE: minor] The Repository Structure table says every instrumentation has a co-located .spec.ts, but src/trace/instrumentation/console-logger.instrumentation.ts has no matching spec file in that directory, so the guidance is inaccurate. Please either add console-logger.instrumentation.spec.ts to match the implementation or update AGENTS.md to reflect the actual test coverage.

Comment thread AGENTS.md Outdated
| --- | --- |
| **Linting** | `npm run lint` must pass (ESLint + `@typescript-eslint`, Prettier integration). |
| **Testing** | `npm run test` / `npm run test:cov` using Jest. Global coverage thresholds: **80% branches**, **90% lines** (`jest.config.js`). |
| **Build** | `npm run build` executes `nest build` after cleaning `dist/` via `rimraf`. Build must succeed with strict TypeScript settings from `tsconfig*.json`. |
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

[IMPORTANCE: minor] The quality standards table states that npm run build must succeed with "strict TypeScript settings from tsconfig*.json", but tsconfig.json / tsconfig.build.json do not enable strict or related flags. This misleads contributors about the current tooling. Please either enable strict mode in the tsconfig files or revise AGENTS.md to describe the actual (non-strict) compiler settings.

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Jan 26, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Jan 28, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Jan 28, 2026

Status update: release notes section has been applied to the PR description and verified.

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Feb 2, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Feb 7, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Copy Markdown
Author

overcut-ai bot commented Feb 17, 2026

Completed Working on "Release PR Description"

✅ Workflow completed successfully.


👉 View complete log

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