Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
109 changes: 109 additions & 0 deletions .claude/commands/code-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
allowed-tools: Bash(gh issue view:*), Bash(gh search:*), Bash(gh issue list:*), Bash(gh pr comment:*), Bash(gh pr diff:*), Bash(gh pr view:*), Bash(gh pr list:*), mcp__github_inline_comment__create_inline_comment
description: Code review a pull request
---

Provide a code review for the given pull request.

**Agent assumptions (applies to all agents and subagents):**
- All tools are functional and will work without error. Do not test tools or make exploratory calls. Make sure this is clear to every subagent that is launched.
- Only call a tool if it is required to complete the task. Every tool call should have a clear purpose.

To do this, follow these steps precisely:

1. Launch a haiku agent to check if any of the following are true:
- The pull request is closed
- The pull request is a draft
- The pull request does not need code review (e.g. automated PR, trivial change that is obviously correct)
- Claude has already commented on this PR (check `gh pr view <PR> --comments` for comments left by claude)

If any condition is true, stop and do not proceed.

Note: Still review Claude generated PR's.

2. Launch a haiku agent to return a list of file paths (not their contents) for all relevant CLAUDE.md files including:
- The root CLAUDE.md file, if it exists
- Any CLAUDE.md files in directories containing files modified by the pull request

3. Launch a sonnet agent to view the pull request and return a summary of the changes

4. Launch 4 agents in parallel to independently review the changes. Each agent should return the list of issues, where each issue includes a description and the reason it was flagged (e.g. "CLAUDE.md adherence", "bug"). The agents should do the following:

Agents 1 + 2: CLAUDE.md compliance sonnet agents
Audit changes for CLAUDE.md compliance in parallel. Note: When evaluating CLAUDE.md compliance for a file, you should only consider CLAUDE.md files that share a file path with the file or parents.

Agent 3: Opus bug agent (parallel subagent with agent 4)
Scan for obvious bugs. Focus only on the diff itself without reading extra context. Flag only significant bugs; ignore nitpicks and likely false positives. Do not flag issues that you cannot validate without looking at context outside of the git diff.

Agent 4: Opus bug agent (parallel subagent with agent 3)
Look for problems that exist in the introduced code. This could be security issues, incorrect logic, etc. Only look for issues that fall within the changed code.

**CRITICAL: We only want HIGH SIGNAL issues.** Flag issues where:
- The code will fail to compile or parse (syntax errors, type errors, missing imports, unresolved references)
- The code will definitely produce wrong results regardless of inputs (clear logic errors)
- Clear, unambiguous CLAUDE.md violations where you can quote the exact rule being broken

Do NOT flag:
- Code style or quality concerns
- Potential issues that depend on specific inputs or state
- Subjective suggestions or improvements

If you are not certain an issue is real, do not flag it. False positives erode trust and waste reviewer time.

In addition to the above, each subagent should be told the PR title and description. This will help provide context regarding the author's intent.

5. For each issue found in the previous step by agents 3 and 4, launch parallel subagents to validate the issue. These subagents should get the PR title and description along with a description of the issue. The agent's job is to review the issue to validate that the stated issue is truly an issue with high confidence. For example, if an issue such as "variable is not defined" was flagged, the subagent's job would be to validate that is actually true in the code. Another example would be CLAUDE.md issues. The agent should validate that the CLAUDE.md rule that was violated is scoped for this file and is actually violated. Use Opus subagents for bugs and logic issues, and sonnet agents for CLAUDE.md violations.

6. Filter out any issues that were not validated in step 5. This step will give us our list of high signal issues for our review.

7. Output a summary of the review findings to the terminal:
- If issues were found, list each issue with a brief description.
- If no issues were found, state: "No issues found. Checked for bugs and CLAUDE.md compliance."

If `--comment` argument was NOT provided, stop here. Do not post any GitHub comments.

If `--comment` argument IS provided and NO issues were found, post a summary comment using `gh pr comment` and stop.

If `--comment` argument IS provided and issues were found, continue to step 8.

8. Create a list of all comments that you plan on leaving. This is only for you to make sure you are comfortable with the comments. Do not post this list anywhere.

9. Post inline comments for each issue using `mcp__github_inline_comment__create_inline_comment` with `confirmed: true`. For each comment:
- Provide a brief description of the issue
- For small, self-contained fixes, include a committable suggestion block
- For larger fixes (6+ lines, structural changes, or changes spanning multiple locations), describe the issue and suggested fix without a suggestion block
- Never post a committable suggestion UNLESS committing the suggestion fixes the issue entirely. If follow up steps are required, do not leave a committable suggestion.

**IMPORTANT: Only post ONE comment per unique issue. Do not post duplicate comments.**

Use this list when evaluating issues in Steps 4 and 5 (these are false positives, do NOT flag):

- Pre-existing issues
- Something that appears to be a bug but is actually correct
- Pedantic nitpicks that a senior engineer would not flag
- Issues that a linter will catch (do not run the linter to verify)
- General code quality concerns (e.g., lack of test coverage, general security issues) unless explicitly required in CLAUDE.md
- Issues mentioned in CLAUDE.md but explicitly silenced in the code (e.g., via a lint ignore comment)

Notes:

- Use gh CLI to interact with GitHub (e.g., fetch pull requests, create comments). Do not use web fetch.
- Create a todo list before starting.
- You must cite and link each issue in inline comments (e.g., if referring to a CLAUDE.md, include a link to it).
- If no issues are found and `--comment` argument is provided, post a comment with the following format:

---

## Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

---

- When linking to code in inline comments, follow the following format precisely, otherwise the Markdown preview won't render correctly: https://github.com/anthropics/claude-code/blob/c21d3c10bc8e898b7ac1a2d745bdc9bc4e423afe/package.json#L10-L15
- Requires full git sha
- You must provide the full sha. Commands like `https://github.com/owner/repo/blob/$(git rev-parse HEAD)/foo/bar` will not work, since your comment will be directly rendered in Markdown.
- Repo name must match the repo you're code reviewing
- # sign after the file name
- Line range format is L[start]-L[end]
- Provide at least 1 line of context before and after, centered on the line you are commenting about (eg. if you are commenting about lines 5-6, you should link to `L4-7`)
86 changes: 86 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Agent guidelines for Dirigent development

Dirigent is a free and open package registry for Composer, the PHP package manager. It allows users to publish private packages and mirror packages from external registries like Packagist.

### Project structure

```
assets/ # Frontend assets
config/ # Symfony configuration
migrations/ # Doctrine migrations (PostgreSQL)
src/
├── Attribute/ # PHP attributes
├── Command/ # Symfony console commands
├── Composer/ # Composer integration logic
├── Controller/ # HTTP controllers
│ └── Dashboard/ # EasyAdmin dashboard controllers
├── Doctrine/
│ ├── Entity/ # Doctrine ORM entities
│ ├── Repository/ # Doctrine repositories
│ ├── Type/ # Custom Doctrine types
│ └── DataFixtures/ # Database fixtures
├── Encryption/ # Encryption utilities
├── Entity/ # Enums (UserRole, PackageUpdateSource)
├── EventListener/ # Symfony event listeners
├── Form/ # Symfony form types
├── Message/ # Symfony messenger messages and handlers (async jobs)
├── Package/ # Package management services
├── Routing/ # Symfony routing logic
├── Twig/ # Twig extensions
└── Validator/ # Symfony validators
templates/ # Twig templates
tests/
├── UnitTests/ # Unit tests
├── FunctionalTests/ # Functional/Integration tests
└── Docker/ # Docker image tests
```

## Coding style

### Project

- Environment variables are stored in `.env.dirigent` and `.env.dirigent.*` (not `.env`).

### PHP

- Follow the PER coding style and the Symfony coding standards.
- Organize services into domain-specific namespaces.
- Always use strict comparisons (`===`, `!==`).
- Enforce the use of DateTimeImmutable over DateTime.
- Always use spaces in concatenation (`$a . $b`).
- Always use imports. Use aliases when collisions occur or the imported name is unclear.
- Don't use blank lines between import groups.

## Commands

### Linting & code quality

```shell
# Run all linting jobs
symfony composer lint

# Individual linters
symfony composer lint:refactor # Rector (automatically applies changes)
symfony composer lint:coding-style # PHP-CS-Fixer (automatically applies changes)
symfony composer lint:static-analysis # PHPStan level 5
symfony composer lint:container # Symfony container validation
symfony composer lint:templates # Twig template validation
```

### Testing

```shell
# Prepare the Symfony test environment for tests (if the database schema changed)
symfony composer tests:setup

# Run all tests
symfony composer tests

# Run only PHP tests
symfony composer tests:php
symfony composer tests:php:unit
symfony composer tests:php:functional

# Run tests for Docker images
symfony composer tests:docker
```
3 changes: 3 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Agent guidelines for Dirigent development in Claude Code

@AGENTS.md
109 changes: 109 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Contributing to Dirigent

Dirigent is an open-source project, contributions of all kind are welcome, including
[financial contributions][codedmonkey-sponsor].

This guide contains technical information and instructions about the development process of the project that you should
follow when contributing code.

## Project information

### Technology stack

- **Languages & frameworks**:
- PHP 8.3+
- Symfony 7.3
- PostgreSQL 16.x (via Doctrine ORM 3.x)
- TypeScript
- **Development requirements**:
- Docker
- Symfony CLI
- **Package managers**:
- **PHP**: Composer
- **TypeScript**: NPM
- **Frontend**: Twig, EasyAdmin 4.x
- **Frontend (JavaScript)**: Webpack Encore, Stimulus
- **Linting**: Rector, PHP-CS-Fixer, PHPStan
- **Testing**: PHPUnit 12.x, Testcontainers

### Coding style

#### PHP

Dirigent follows the [PER coding style][per-coding-style] and the [Symfony coding standards][symfony-coding-standards].

## Running Dirigent locally

### Installation

To run Dirigent locally, follow the [Running from source code][docs-install-source] guide in the documentation,
up to the *Configure services* section.

Additional requirements:

- Symfony binary
- Docker


```shell
# Optionally, copy the example Docker Compose configuration override file
cp compose.override.example.yaml compose.override.yaml

# Install dependencies
composer install
npm install

# Build frontend assets
npm run build # or watch for changes with: npm run watch

# Run services through Docker Compose
docker compose up -d

# Run the Symfony development server
symfony server:start -d

# Create & fill the development database
symfony console doctrine:database:create --if-not-exists
symfony console doctrine:schema:update --force
symfony console doctrine:fixtures:load --no-interaction
```

## Lint & validate the code

```shell
# Run all linting jobs
symfony composer lint

# Individual linters
symfony composer lint:refactor # Rector (automatically applies changes)
symfony composer lint:coding-style # PHP-CS-Fixer (automatically applies changes)
symfony composer lint:static-analysis # PHPStan level 5
symfony composer lint:container # Symfony container validation
symfony composer lint:templates # Twig template validation
```

### Running tests

```shell
# Prepare the Symfony test environment (if the database schema changed)
symfony composer tests:setup
```

```shell
# Run all tests
symfony composer tests

# Run only PHP tests
symfony composer tests:php
symfony composer tests:php:unit
symfony composer tests:php:functional

# Run tests for Docker images
symfony composer tests:docker
symfony composer tests:docker:standalone
```

[codedmonkey-sponsor]: https://github.com/sponsors/codedmonkey
[docs-install-source]: ./docs/installation/source.md
[per-coding-style]: https://www.php-fig.org/per/coding-style/
[symfony-coding-standards]: https://symfony.com/doc/current/contributing/code/standards.html
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ until it's second anniversary. See our [full license][license] for more details.

## Contributing

Feel free to report issues and make suggestions on [GitHub][github-issues] or follow our [contribution guide](contributing.md).
Feel free to report issues and make suggestions on [GitHub][github-issues] or follow our [contribution guide](CONTRIBUTING.md).

## About Me

Dirigent is developed by [Coded Monkey][codedmonkey].

[codedmonkey]: https://www.codedmonkey.com
[codedmonkey-sponsor]: https://www.codedmonkey.com/sponsor?project=dirigent
[codedmonkey-sponsor]: https://github.com/sponsors/codedmonkey
[composer]: https://getcomposer.org
[dirigent]: https://dirigent.dev
[docs]: docs/readme.md
Expand Down
10 changes: 8 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,12 @@
"@tests:php:functional"
],
"tests:php:functional": "bin/phpunit tests/FunctionalTests",
"tests:php:unit": "bin/phpunit tests/UnitTests"
"tests:php:unit": "bin/phpunit tests/UnitTests",
"tests:setup": [
"bin/console --env=test doctrine:database:create --if-not-exists",
"bin/console --env=test doctrine:schema:update --force",
"bin/console --env=test doctrine:fixtures:load --no-interaction"
]
},
"scripts-descriptions": {
"build:standalone": "Build the standalone image",
Expand All @@ -162,7 +167,8 @@
"tests:docker:standalone": "Run tests in the standalone image",
"tests:php": "Run all PHP tests",
"tests:php:functional": "Run the functional test suite",
"tests:php:unit": "Run the unit test suite"
"tests:php:unit": "Run the unit test suite",
"tests:setup": "Prepare the Symfony test environment"
},
"config": {
"allow-plugins": {
Expand Down
46 changes: 0 additions & 46 deletions contributing.md

This file was deleted.

Loading
Loading