Skip to content

Add AGENTS.md #4094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
magicmark wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add AGENTS.md #4094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9931de2
add AGENTS.md
magicmark Jan 9, 2026
4ffd642
Update AGENTS.md
magicmark Jan 26, 2026
f59ad39
Merge branch 'strawberry-graphql:main' into add_agents
magicmark Jan 26, 2026
6bd0b9e
add CLAUDE.md
magicmark Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# AGENTS.md

Strawberry GraphQL

- Docs: https://strawberry.rocks/docs
- Repo: https://github.com/strawberry-graphql/strawberry

## Setup

```shell
$ poetry install --with integrations # Install dependencies
$ poetry run pre-commit install # Install git hooks (auto-runs checks on commit)
```

## Commands

- **Test:** `poetry run pytest`
- **Type check:** `poetry run mypy`
- **Lint:** `poetry run ruff check .`
- **Format:** `poetry run ruff format .`

## Code Style

- Ruff for linting/formatting (line length 88)
- mypy strict mode - all code must be fully typed
- Decorator-based schema: `@strawberry.type`, `@strawberry.field`, `@strawberry.mutation`
- Async-first design

## Structure

- `strawberry/` - Core library
- `schema/` - Schema definition/execution
- `types/` - GraphQL type definitions
- `extensions/` - Built-in extensions
- `django/`, `fastapi/`, `flask/`, etc. - Framework integrations
- `tests/` - pytest suite with integration markers (`django`, `fastapi`, `pydantic`, etc.)

## PR Requirements

- Include `RELEASE.md` file describing changes
- Release types: patch/minor/major
- Tests required for all code changes with full coverage
Comment on lines +40 to +42
Copy link
Member

@patrick91 patrick91 Jan 9, 2026

Choose a reason for hiding this comment

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

shall we add an example of release file too? 😊

Copy link
Member

@patrick91 patrick91 Jan 20, 2026

Choose a reason for hiding this comment

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

let's also add a CLAUDE.md with @AGENTS.md 😊

Copy link
Contributor Author

@magicmark magicmark Jan 26, 2026

Choose a reason for hiding this comment

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

shall we add an example of release file too? 😊

would be cool to make this a skill

Copy link
Member

@erikwrede erikwrede Jan 27, 2026

Choose a reason for hiding this comment

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

same thing goes for schema tests for a new skill, think of a new /generate-tests command which generates the test file structure, schema, query inputs and expected outputs.

1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md