Skip to content

docs: add CLAUDE.md for Claude Code guidance#97

Merged
joeltjames merged 1 commit intomainfrom
jt/add-claude-md
Apr 6, 2026
Merged

docs: add CLAUDE.md for Claude Code guidance#97
joeltjames merged 1 commit intomainfrom
jt/add-claude-md

Conversation

@joeltjames
Copy link
Copy Markdown
Collaborator

Summary

  • Adds CLAUDE.md to orient Claude Code when working in this repo
  • Covers essential commands, project structure, and development practices
  • Points to existing docs/ directory for domain concepts before implementing features

Test plan

  • N/A — documentation only

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 6, 2026 16:13
@joeltjames joeltjames merged commit 9419f51 into main Apr 6, 2026
2 checks passed
@joeltjames joeltjames deleted the jt/add-claude-md branch April 6, 2026 16:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request adds a CLAUDE.md file to provide guidance to Claude Code when working in this repository. The file covers the project's purpose as a GitHub Action that syncs pull requests to Asana tasks, lists essential development commands, describes the project structure, references user-facing documentation, and outlines development practices.

Changes:

  • Adds CLAUDE.md with project overview, essential commands, project structure documentation, user-facing documentation references, and development practices guidelines

Comment on lines +11 to +12
- `bun test` - Run tests
- `bun test --watch` - Watch mode
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

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

The test command format is inconsistent with other commands in the list. Lines 13-18 all use bun run, but lines 11-12 do not. Additionally, to match the behavior defined in package.json, use bun run test (which runs bun test --coverage) and bun run test:watch instead.

Suggested change
- `bun test` - Run tests
- `bun test --watch` - Watch mode
- `bun run test` - Run tests with coverage
- `bun run test:watch` - Watch mode

Copilot uses AI. Check for mistakes.

The `docs/` directory contains VitePress documentation for action users. Read these before implementing or modifying features:

- `docs/concepts/` - Rules, conditions, actions, templates (domain model)
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

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

The docs/guide/ directory exists and contains important setup documentation (installation.md and your-first-rule.md) but is not listed in the User-Facing Documentation section. Add docs/guide/ to this section to help developers find setup and workflow guidance.

Suggested change
- `docs/concepts/` - Rules, conditions, actions, templates (domain model)
- `docs/concepts/` - Rules, conditions, actions, templates (domain model)
- `docs/guide/` - Setup and workflow guidance, including installation and your first rule

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants