README

Development convention rules for Claude Code. Provides reusable coding conventions for PHP, Laravel, Vue, TypeScript, Python, and more.

Installation

composer require rasmusgodske/godske-dev-rules --dev

Usage

After installation, run the artisan command to sync rules to your project:

php artisan dev-rules:update

This copies the rules to .claude/rules/techstack/ in your project.

Options

# Update rules (overwrites existing)
php artisan dev-rules:update --force

# Custom installation path
php artisan dev-rules:update --path=.claude/rules/custom

Rule Categories

How Rules Work

Rules are markdown files that Claude Code automatically loads based on file paths. Each rule has YAML frontmatter specifying when it should load:

---
paths: app/**/*.php
---

# PHP Conventions

Your conventions here...

When you edit a .php file, rules matching app/**/*.php are loaded automatically.

Directory Structure

After running dev-rules:update, your project will have:

.claude/rules/
├── techstack/           # Rules from this package (synced)
│   ├── backend/
│   ├── frontend/
│   ├── dataclasses/
│   ├── e2e/
│   ├── principles/
│   └── python/
└── project/             # Your custom rules (not synced)
    ├── backend/
    └── frontend/

Custom Rules

Add project-specific rules to .claude/rules/project/. These are NOT overwritten when running dev-rules:update.

Updating Rules

When a new version of this package is released:

composer update rasmusgodske/godske-dev-rules
php artisan dev-rules:update --force

Contributing

See CONTRIBUTING.md for guidelines on adding or modifying rules.

Migration from laravel-vue-rules

If you were using rasmusgodske/laravel-vue-rules:

1. Remove the old package:

   composer remove rasmusgodske/laravel-vue-rules

2. Install the new package:

   composer require rasmusgodske/godske-dev-rules --dev

3. Update your rules:

   php artisan dev-rules:update --force

The new package includes all the same rules plus Python conventions.

License

MIT