Skip to content

Create AGENTS.md file for SCORE project #3100

Description

@praveen-ltts

What

Create AGENTS.md file for SCORE repository

Why AGENTS.md?

README.md files are for humans: quick starts, project descriptions, and contribution guidelines.

AGENTS.md complements this by containing the extra, sometimes detailed context coding agents need: build steps, tests, and conventions that might clutter a README or aren’t relevant to human contributors.

In the current world of AI, AGENTS.md give agents a clear, predictable place for instructions.

Acceptance Criteria (DoD)

Below mentioned are sample AGENTS.md content based on different use cases.

Dev environment tips

  • Use pnpm dlx turbo run where <project_name> to jump to a package instead of scanning with ls.
  • Run pnpm install --filter <project_name> to add the package to your workspace so Vite, ESLint, and TypeScript can see it.
  • Check the name field inside each package's package.json to confirm the right name—skip the top-level one.

Testing instructions

  • Find the CI plan in the .github/workflows folder.
  • Run pnpm turbo run test --filter <project_name> to run every check defined for that package.
  • From the package root you can just call pnpm test. The commit should pass all tests before you merge.
  • To focus on one step, add the Vitest pattern: pnpm vitest run -t "<test name>".
  • Fix any test or type errors until the whole suite is green.

PR instructions

  • Title format: [<project_name>] <Title>
  • Always run pnpm lint and pnpm test before committing.

How

No response

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions