mirror of https://github.com/windmill-labs/windmill.git synced 2026-08-19 08:01:25 +00:00

Files

T

centdix 2dad2b43a4 internal: Improve instructions for claude (#7921 )

* Improve CLAUDE.md instructions and compact DB schema summary

- Add code validation instructions (cargo check, npm run check) to all
  CLAUDE.md files with guidance to use only relevant feature flags
- Reference backend/CLAUDE.md and frontend/CLAUDE.md paths from root
- Add database querying guidance (psql commands for exact table info)
- Compact summarize_schema.py output: inline columns, shorten types,
  one-line enums, drop indexes (use psql \d for exact info)
- Fix FK parsing for multi-line ALTER TABLE statements
- Result: schema summary reduced from 1514 lines/40KB to 194 lines/23KB

* cleaning

* fix: use prefix-based type abbreviations and filter CONSTRAINT pseudo-columns

- Change TYPE_ABBREVIATIONS matching from exact to prefix-based so
  parametrized types (character(64) -> char(64)) and array types
  (integer[] -> int[], real[] -> float[]) are properly abbreviated
- Skip CONSTRAINT lines inside CREATE TABLE blocks that were being
  incorrectly matched as columns by the column regex
- Update summarized_schema.txt to reflect both changes

Co-authored-by: centdix <centdix@users.noreply.github.com>

---------

Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: centdix <centdix@users.noreply.github.com>

2026-02-12 07:19:44 +00:00

3.2 KiB

Raw Blame History

Backend Development (Rust)

Project Structure

Windmill uses a workspace-based architecture with multiple crates:

windmill-api: API server functionality
windmill-worker: Job execution
windmill-common: Shared code used by all crates
windmill-queue: Job & flow queuing
windmill-audit: Audit logging
Other specialized crates (git-sync, autoscaling, etc.)

Key References (MUST FOLLOW THESE)

You MUST follow best-practices by using the rust-backend skill, everytime you write RUST code.
When working with the database: read summarized_schema.txt before starting
When working with the API routes: you can read windmill-api/src/lib.rs to get started

Adding New Code

Module Organization

Place new code in the appropriate crate based on functionality
For API endpoints, create or modify files in windmill-api/src/ organized by domain
For shared functionality, use windmill-common/src/
Follow existing patterns for file structure and organization

API Endpoints

Follow existing patterns in the windmill-api crate
Use axum's routing system and extractors
Update backend/windmill-api/openapi.yaml after modifying API endpoints

Database Changes

Update database schema with migration if necessary
Use sqlx for database operations with prepared statements
Use transactions for multi-step operations
To apply pending migrations: sqlx migrate run (never manually run .sql files)
Never use SQLX_OFFLINE=true — a live database is always available for compilation
After all code changes are done, run ./update-sqlx to regenerate the offline query cache

Enterprise Features

Enterprise files use the *_ee.rs suffix
Enterprise source is in windmill-ee-private folder (sibling directory at ../../windmill-ee-private), symlinked into each crate's src/
You can and should modify windmill-ee-private directly when needed (e.g., when creating new crates that need EE code, mirror the package structure there)
Use feature flags: #[cfg(feature = "enterprise")]
Isolate enterprise code in separate modules

Code Validation (MUST DO)

After making backend changes, you MUST run cargo check and fix all errors and warnings before considering the work done.

Only enable the feature flags relevant to your changes — do NOT use all_sqlx_features as it compiles the entire codebase and is very slow. Check the [features] section in Cargo.toml to identify which flags gate the crates/modules you modified.

Examples:

# Changed core code (no feature-gated modules)
cargo check

# Changed code behind the enterprise feature
cargo check --features enterprise

# Changed kafka trigger code
cargo check --features kafka

Git Workflow

Never push directly to main — always create a branch and open a pull request

Testing

Write unit tests for core functionality
Use the #[cfg(test)] module for test code
For database tests, use the existing test utilities

Common Crates

tokio: Async runtime
axum: Web server and routing
sqlx: Database operations
serde: Serialization/deserialization
tracing: Logging and diagnostics
reqwest: HTTP client

3.2 KiB Raw Blame History