Skip to content

Commit 308a105

Browse files
committed
chore(ai): improve AI instructions
1 parent 02504b9 commit 308a105

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

.github/workflows/copilot-setup-steps.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ jobs:
3030

3131
- uses: oxc-project/setup-rust@cd82e1efec7fef815e2c23d296756f31c7cdc03d # v1.0.0
3232
with:
33-
cache-key: copilot
34-
save-cache: ${{ github.ref_name == 'main' }}
33+
cache-key: warm
34+
save-cache: false
3535
tools: just,watchexec-cli,cargo-insta,typos-cli,cargo-shear,dprint
36+
components: clippy rust-docs rustfmt
3637

3738
- uses: oxc-project/setup-node@f42e3bda950c7454575e78ee4eaac880a077700c # v1.0.0
3839

AGENTS.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ The repository follows a Rust workspace structure with multiple crates:
2727
- **`tasks/`** - Development tools, testing, and automation scripts
2828
- **`editors/`** - Editor integrations (VS Code extension, etc.)
2929

30+
Start from the `crates/` directory when exploring the codebase.
31+
32+
Sub-directories named `generated` are code generated, do not edit files in these directories.
33+
34+
3035
### Important Crates Overview
3136

3237
- **`oxc_parser`** - JavaScript/TypeScript parser
@@ -56,34 +61,39 @@ The project uses several tools for development:
5661
The project uses `just` as the primary command runner. Key commands include:
5762

5863
```bash
59-
# Initialize development environment
60-
just init
64+
# List available commands
65+
just --list
6166

62-
# Run all checks (the "ready" command)
67+
# Run all checks
6368
just ready
6469

6570
# Individual commands
66-
just fmt # Format code
71+
just fmt # Format code. Run after any code modifications.
6772
just check # Check code without building
6873
just test # Run tests
6974
just lint # Run linting
7075
just doc # Generate documentation
71-
just ast # When directory `crates/oxc_ast` changes
76+
just ast # Update generated files. Run when directory `crates/oxc_ast` changes
77+
just conformance # Run conformance tests. Run when any Rust code changes.
7278
```
7379

7480
### Building and Testing
7581

82+
`just init` has already been run, all tools (`watchexec-cli`, `cargo-insta`, `typos-cli`, `cargo-shear`, `dprint`) are already installed, do not run `just init`.
83+
84+
Rust and `cargo` components `clippy`, `rust-docs` and `rustfmt` has already been installed, do not install them.
85+
7686
```bash
77-
# Build all crates
78-
cargo build
87+
# Check all Rust code.
88+
just check
7989

8090
# Run all tests
81-
cargo test
91+
just test
8292

8393
# Build Node.js bindings
84-
pnpm build
94+
pnpm build-dev
8595

86-
# Run Node.js tests
96+
# Run end-to-end Node.js tests
8797
pnpm test
8898
```
8999

0 commit comments

Comments
 (0)