Code Quality

Code Quality & Reviews

modbender Updated 12 repo stars

File contents

Code Quality & Reviews

Clean Code Principles

Principle Description
SRP One responsibility per function/class
DRY Don't Repeat Yourself
KISS Keep It Simple
YAGNI You Aren't Gonna Need It
naming Clear, descriptive names

Code Review Checklist

Before Submitting

  • Code compiles without errors
  • Tests pass
  • No console.log/debug code
  • Types are correct
  • No hardcoded secrets

Review Points

  • Logic is correct
  • Error handling is proper
  • Performance is acceptable
  • Security considerations
  • Code is readable

PR Standards

## Description
Brief description of changes

## Type
- [ ] Bug fix
- [ ] Feature
- [ ] Refactor

## Testing
- [ ] Unit tests added
- [ ] Integration tests pass

## Screenshots (if UI)

Checklist

  • Follow naming conventions
  • Write self-documenting code
  • Keep functions small
  • Handle errors properly
  • Add comments for complex logic
  • Review your own PR first

modbender/skill-library-mcp/tree/main/data/fswe/references/code-quality commit 203c8a1604

Frequently asked questions

npx skillmds@latest add modbender/code-quality