mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-08-21 08:02:26 +00:00
centdix
3562220120
* add new feature instructions * add db as context for flow mode * add diff * cleaner diff * add modules as available context * convert to svelte 5 * auto add selected module to context * change flowinline ai button + nits * handle adding selected lines * clean context handling * apply code pieces * new chat when changing mode * clean * show code for code steps * add last saved flow * fix size * categorize context * optionnaly categorize * fix module finding * logs * nit prompt * fix * fix * fix test tool for script * clean
22 lines
1.3 KiB
Markdown
22 lines
1.3 KiB
Markdown
# Windmill Development Guide
|
|
|
|
## Overview
|
|
|
|
Windmill is an open-source developer platform for building internal tools, workflows, API integrations, background jobs, workflows, and user interfaces. See @windmill-overview.mdc for full platform details.
|
|
|
|
## New Feature Implementation Guidelines
|
|
|
|
When implementing new features in Windmill, follow these best practices:
|
|
|
|
- **Clean Code First**: Write clean, readable, and maintainable code. Prioritize clarity over cleverness.
|
|
- **Avoid Duplication at All Costs**: Before writing new code, thoroughly search for existing implementations that can be reused or extended.
|
|
- **Adapt Existing Code**: Refactor and generalize existing code when necessary to avoid logic duplication. Extract common patterns into reusable utilities.
|
|
- **Follow Established Patterns**: Study existing code patterns in the codebase and maintain consistency with established conventions.
|
|
- **Single Responsibility**: Each function, component, and module should have a single, well-defined responsibility.
|
|
- **Incremental Implementation**: Break large features into smaller, reviewable chunks that can be implemented and tested incrementally.
|
|
|
|
## Language-Specific Guides
|
|
|
|
- Backend (Rust): @backend/rust-best-practices.mdc + @backend/summarized_schema.txt
|
|
- Frontend (Svelte 5): @frontend/svelte5-best-practices.mdc
|