mirror of https://github.com/windmill-labs/windmill.git synced 2026-08-23 08:00:45 +00:00

Files

T

centdix d004aa8ec1 internal: add Rust backend coding skill and consolidate guidelines (#7731 )

* feat: add Rust backend coding skill and consolidate guidelines

Create a dedicated skill at .claude/skills/rust-backend/SKILL.md that
provides comprehensive Rust coding guidelines adapted to Windmill patterns:
- Iterator chains, error handling, early returns, variable shadowing
- JSON handling with Box<RawValue>, Serde optimizations
- SQLx patterns (no SELECT *, batch operations, avoid N+1)
- Async/Tokio patterns (spawn_blocking, bounded channels)

Consolidate project context into backend/CLAUDE.md and remove the
redundant rust-best-practices.mdc file.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* add command plugins

* nit

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-29 12:02:27 +00:00

1.9 KiB

Raw Permalink 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

Database schema: @summarized_schema.txt
API route prefixes: windmill-api/src/lib.rs

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

Enterprise Features

Enterprise files use the *_ee.rs suffix
Enterprise source is in windmill-ee-private folder (sibling directory), symlinked into each crate's src/
Use feature flags: #[cfg(feature = "enterprise")]
Isolate enterprise code in separate modules

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

Coding Guidelines

Detailed Rust coding patterns and best practices are provided by the rust-backend skill.

1.9 KiB Raw Permalink Blame History