README.md

Code Challenge Review Checklist

An Opinionated Checklist for Reviewing a Code Challenge

Algorithm

1. BigO
2. Recursive Approach
3. Covers edge cases
4. Example provided matches
5. Return values matches

Clean Code

1. Production ready
2. No dead code
3. No commented code
4. Namespace usage
5. No global variables
6. Correct visibility modifiers
7. No duplicated code
8. No empty blocks
9. Correct data types or structures
10. Design patterns
11. No mixed tabs vs spaces
12. No Getters & Setters
13. Use Exceptions rather than return codes
14. Don't return null
15. Make class final if not being used for inheritance
16. Dependency Injection
17. No Dependency Cycles

Coding Style

1. Code linted
2. Respecting community standards
3. No issue phpcbf
4. No issue php-cs-fixer
5. Folder structure
6. No debug code

Complexity

1. No complex expressions
2. No bitwise operations
3. No magic variables
4. No magic values
5. No magic methods
6. Law of Demeter
7. No over engineered

Documentation

1. DocBlocks
2. README file
3. Usage
4. Code readability
5. CLI help
6. No TODOs
7. No HACKs
8. Logs
9. Unusual behaviour is commented
10. UML

Environment

1. Dockerized
2. Docker-compose
3. .env file

i18n

1. Translations

Language

1. Package manager
2. Version within EOL
3. Using most recent version

Paradigms

1. DRY
2. GRASP
3. Quick & dirty
4. SOLID
5. OOP

Performance

1. Speed
2. Number of loops

Presentation

1. Color shell

Readability

1. Variables names
2. Spelling
3. No double negations
4. No nested if, for, ...

Security

1. No Buffer overflow
2. No Freezing (infinite loop, memory leaks)
3. No stacktraces
4. Immutable variables
5. Exceptions catching
6. Closing resources (files, streams, ...)
7. Input validation
8. No deprecates
9. No warnings
10. No eval

Tests

1. Unit tests
2. Functional tests
3. Coverage > 80%
4. CI/CD tools

Versioning

1. Git repo
2. Many small commits
3. Good commit messages
4. .gitignore