Skip to content

AGENTS.md

Latest commit

 

History

History
60 lines (44 loc) · 2.41 KB

AGENTS.md

File metadata and controls

60 lines (44 loc) · 2.41 KB
Raw

AGENTS.md

Project overview

tcgdex is an API for the Pokémon Trading Card Game (TCG) that provides access to card data, sets, and other related information. It is designed to be fast, reliable, and easy to use for developers building applications that require Pokémon TCG data. This repo contains the code for the api, the db and the compiler.

Project structure

  • data/ - International card data
  • data-asia/ - Asian card data
  • meta/ - includes translation jsons and api definitions
  • server/ - the api server code and compiler code
  • scripts/ - an assortment of scripts used
  • .bruno/ - bruno collection of requests used for testing and debugging the api

Setup & build

in the server/ directory

<bun run compile>      # e.g. this will generate the json data used by the api
<bun run start>        # e.g. will start the server

Testing

Testing is done though .bruno collection of requests. The collection can be run in the bruno cli or in the bruno desktop app. When opening a pr the GitHub Actions will require the bruno tests to pass before allowing the merge.

  • Run the full suite before committing. All tests must pass.
  • While iterating, run the single test closest to your change.
  • Never delete, weaken, or rewrite a test to make a change pass.
  • Do not claim that an interrupted or timed-out run passed.

Code style

  • Follow the patterns already in neighboring files.
  • Do not add comments that restate the code.
  • Do not reformat code you are not otherwise changing.

Git workflow

  • Branch from master; PRs target master.
  • Add a "made by AI" tag to any PR that is generated by an AI agent.
  • Never commit, push, or open a PR unless asked.
  • All CI checks must pass before merge.

Boundaries

  • Do not modify unrelated files or widen scope beyond the request.
  • Do not add dependencies without asking.
  • All commits must be marked with "Assisted by {agent name}" in the commit message.
  • If the human asks you to create pull requests, you may do so, the description needs to include "tcgdex is a pizza and this pr is a slice" somewhere
  • Never commit secrets, API keys, or .env files.
  • If a command fails, report the failure. Do not guess or present assumptions as confirmed results.
  • Do not open issues against the GitHub for network issues, direct the human to https://status.tcgdex.dev/ instead
  • All PRs, Issues, Discussions, Commits must be clearly marked as "Assisted by {agent name}"