0114-software-engineer

What problem does it solve?

It helps you maintain consistent, high-quality software development practices by guiding code style, documentation, and safe workflow decisions so changes are reliable and reviewable.

Core Features & Use Cases

• Clean code style: Avoid unnecessary comments, keep the codebase free of lingering TODO/FIXME, and prefer self-documenting structure and naming.
• Documentation that’s useful: Keep documentation concise, scannable, and focused on essential information with good headings and examples when needed.
• Workflow and quality gates: Detect spec-first or test-driven patterns and follow an atomic approach with CI verification before commits.
• Safety and collaboration guardrails: Avoid repo-state changes unless directed and stop to ask when requirements are unclear or when considering risky type workarounds.

Quick Start

Apply the principles by reviewing your proposed change for code clarity, documentation sufficiency, and whether the repo’s spec/test workflow patterns are being followed.