-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add CLAUDE.md for Claude Code guidance #97
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.
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
Merged
+69
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,69 @@ | ||||||||
| # CLAUDE.md | ||||||||
|
|
||||||||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||||||||
|
|
||||||||
| ## Overview | ||||||||
|
|
||||||||
| GitHub Action (TypeScript/Bun) that syncs GitHub pull requests to Asana tasks via rule-based automation. Entry point: `src/index.ts`. Built output in `dist/` is committed and used directly by the action runtime. | ||||||||
|
|
||||||||
| ## Essential Commands | ||||||||
|
|
||||||||
| - `bun test` - Run tests | ||||||||
| - `bun test --watch` - Watch mode | ||||||||
| - `bun run package` - Bundle to dist/index.js (esbuild) | ||||||||
| - `bun run build` - Type-check only (tsc) | ||||||||
| - `bun run lint` - Lint | ||||||||
| - `bun run lint:fix` - Lint with fixes | ||||||||
| - `bun run format` - Format (prettier) | ||||||||
| - `bun run all` - Format, lint, test, package | ||||||||
|
|
||||||||
| ## Project Structure | ||||||||
|
|
||||||||
| ``` | ||||||||
| src/ | ||||||||
| index.ts Action entry point | ||||||||
| types.ts Shared types | ||||||||
| rules/ Rule engine | ||||||||
| engine.ts Evaluates rules against PR events | ||||||||
| validator.ts Validates rule config | ||||||||
| types.ts | ||||||||
| expression/ Condition expression evaluation | ||||||||
| evaluator.ts | ||||||||
| context.ts PR context builder | ||||||||
| helpers.ts | ||||||||
| util/ | ||||||||
| asana/ Asana API client | ||||||||
| client.ts | ||||||||
| create.ts Task creation | ||||||||
| update.ts Field updates | ||||||||
| tasks.ts Task lookup | ||||||||
| fields.ts Custom field resolution | ||||||||
| config.ts Action input parsing | ||||||||
| github.ts GitHub API helpers | ||||||||
| parser.ts YAML rules parser | ||||||||
| retry.ts Retry logic | ||||||||
| template-analysis.ts Handlebars template utilities | ||||||||
| __tests__/ Tests mirror src/ structure | ||||||||
| rules/ | ||||||||
| util/ | ||||||||
| integration/ | ||||||||
| dist/ Bundled output — commit after packaging | ||||||||
| docs/ VitePress user-facing documentation | ||||||||
| ``` | ||||||||
|
|
||||||||
| ## User-Facing Documentation | ||||||||
|
|
||||||||
| The `docs/` directory contains VitePress documentation for action users. Read these before implementing or modifying features: | ||||||||
|
|
||||||||
| - `docs/concepts/` - Rules, conditions, actions, templates (domain model) | ||||||||
|
||||||||
| - `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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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, usebun run test(which runsbun test --coverage) andbun run test:watchinstead.