engineering-standards

What problem does it solve?

Inconsistent code quality, unclear Git practices, and ineffective code reviews can slow down development and introduce bugs. This Skill provides a comprehensive guide to general software engineering best practices, ensuring high-quality, maintainable code and efficient team collaboration.

Core Features & Use Cases

• Clean Code & Naming: Guidelines for writing self-explanatory code with clear, consistent naming conventions.
• Git Workflow: Standards for commit messages, branch naming, and Pull Request descriptions to streamline version control.
• Code Review & Refactoring: Best practices for conducting constructive code reviews and safely refactoring code with confidence.
• Use Case: Before submitting a Pull Request, activate this Skill to review the checklist for commit message formatting, code quality, and documentation, ensuring your contribution meets project standards and passes review quickly.

Quick Start

Commit message example:

git commit -m "feat: add PDF/EPUB content extraction"

Branch naming example:

git checkout -b feat/pdf-epub-support

Refactoring principle: Red -> Green -> Refactor

1. Ensure tests exist and pass.

2. Make small, incremental changes.

3. Run tests after each change.