Instruction file imported from rh-ai-quickstart/quickstart-cli (.cursor/rules/project-standards.mdc). Copyright stays with the author.

Project Standards

Name: project-standards
Author: rh-ai-quickstart

GENERAL PRINCIPLES

Clarity over cleverness - Optimize for maintainability and readability
Single source of truth - Types, environment variables, design tokens, and configuration
Small and cohesive - Keep functions, modules, and components focused
Fail fast in dev, gracefully in prod - Loud failures during development, user-friendly errors in production
Automate consistency - Use formatters, linters, codegen, and CI gates

DOCUMENTATION

Keep CLI help text concise but informative
Include examples in README for common use cases
Document template customization options
Provide migration guides when updating template structures
Living README - Keep setup, scripts, and architecture overview current
Clean code - Inline docs for complex logic; delete dead code and stale comments

VERSION CONTROL

Use Conventional Commits for commit messages
Small, focused pull requests with clear intent
Require code review before merging
Semantic versioning for releases
Maintain CHANGELOG for all releases

SECURITY

Store secrets only in secure environment variables; never commit secrets
Validate all inputs at boundaries
Follow principle of least privilege
Regular dependency updates with security scanning

{ "ocm": "1", "id": "rh-ai-quickstart-quickstart-cli-project-standards-rule", "kind": "skill", "name": "project-standards", "description": "General project standards and documentation guidelines", "publisher": "rh-ai-quickstart", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-cursor-rules" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "General project standards and documentation guidelines" ], "primary": false, "metadata": { "source": { "provider": "github-cursor-rules", "repository": "https://github.com/rh-ai-quickstart/quickstart-cli", "path": ".cursor/rules/project-standards.mdc", "ref": "f686ac2e602b2fb814d88bf0da2364f8a7f9a7df", "url": "https://github.com/rh-ai-quickstart/quickstart-cli/blob/f686ac2e602b2fb814d88bf0da2364f8a7f9a7df/.cursor/rules/project-standards.mdc", "key": "rh-ai-quickstart/quickstart-cli/.cursor/rules/project-standards.mdc" } }, "instructions": "# Project Standards\n\n## GENERAL PRINCIPLES\n- **Clarity over cleverness** - Optimize for maintainability and readability\n- **Single source of truth** - Types, environment variables, design tokens, and configuration\n- **Small and cohesive** - Keep functions, modules, and components focused\n- **Fail fast in dev, gracefully in prod** - Loud failures during development, user-friendly errors in production\n- **Automate consistency** - Use formatters, linters, codegen, and CI gates\n\n## DOCUMENTATION\n- Keep CLI help text concise but informative\n- Include examples in README for common use cases\n- Docume", "cost": { "context_tokens": 324 } }

project-standards

About

Project Standards

GENERAL PRINCIPLES

DOCUMENTATION

VERSION CONTROL

SECURITY

Use it

Manifest

Reviews