Back to Discover
Prompt
Please generate a comprehensive 'Development Guidelines' Cursor rule based on the project's technical stack, which can be inferred from documents like PRD.adoc and DESIGN.adoc. This rule should serve as a vital resource for developers, outlining engineering best practices, project-specific conventions, and operational procedures.
The structure of the generated rule should be well-organized, ideally starting with general principles and then detailing technology-specific guidelines (similar to how a comprehensive `development-guidelines.mdc` rule might be laid out).
The rule **must** include the following sections, with details as described:
1. **Universal Coding Principles:**
* Detail fundamental programming principles that all contributions should adhere to (e.g., SOLID, KISS, DRY, YAGNI, and any other relevant principles).
* Explain the importance and application of these principles within the project's context.
2. **Environment Setup and Management:**
* Provide a step-by-step guide for setting up the local development environment from scratch.
* Clearly explain how project dependencies are managed:
* Specify the tool(s) used (e.g., `uv`, `pip`, `poetry`, `npm`, `yarn`).
* List and explain common commands for installing, adding, removing, updating, and locking dependencies.
* *(Important Note: This section should accurately reflect the project's established practices for environment and dependency management. Avoid enforcing a specific tool unless it is the definitive standard for this project.)*
3. **Packaging / Project Layout:**
* Illustrate and explain the project's directory structure.
* Describe the purpose and responsibility of key files, modules, and directories.
* If applicable, outline conventions for code organization, module naming, and project packaging or distribution.
4. **Specific Technology Guidelines:**
* For *each* significant technology, library, framework, or platform used in the project's stack (as identified from the PRD/DESIGN docs or other sources):
* Create a dedicated, clearly-titled subsection.
* Detail established best practices for using this technology *within the context of this project*.
* Document any project-specific configurations, helper functions, or extension patterns.
* Warn against common pitfalls, anti-patterns, or deprecated features.
* Include links to relevant official documentation or key resources for that technology.
5. **Testing & CI/CD:**
* Describe the project's overall testing strategy (e.g., types of tests: unit, integration, end-to-end; expected coverage).
* Specify the testing frameworks and tools used for each type of test.
* Provide guidelines on how to write, organize, and run tests.
* Outline the Continuous Integration (CI) and Continuous Deployment (CD) processes, including branch strategies, automated checks, and deployment steps.
6. **Documentation:**
* Set expectations for in-code documentation (e.g., comments, docstrings) and external documentation (e.g., READMEs, wikis).
* Specify any preferred formats or tools for documentation.
* Reinforce the importance of keeping documentation up-to-date and provide guidelines on how and when to update it.
* Establish conventions for linking to or referencing official documentation for third-party tools and libraries.
When generating this rule, please ensure the language is precise, actionable, and easy for developers of all levels to understand and follow. The goal is to create a practical guide that enhances code quality, consistency, and maintainability.
Before you begin, do you need any further clarification on the typical contents of the project's PRD.adoc and DESIGN.adoc (from which the tech stack is derived), or on the specific expectations for any of the sections outlined above?