https://github.com/samuelwill/csharp-code-review-checklist

C# Code Review Checklist
https://github.com/samuelwill/csharp-code-review-checklist

Last synced: 19 days ago
JSON representation

C# Code Review Checklist

• Host: GitHub
• URL: https://github.com/samuelwill/csharp-code-review-checklist
• Owner: samuelwill
• Created: 2020-04-03T19:45:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-04-04T20:43:26.000Z (over 4 years ago)
• Last Synced: 2024-07-31T21:53:12.601Z (4 months ago)
• Size: 1.95 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## C# Code Review Checklist

### General

- [ ] Access modifiers are made as private as possible

### Maintainence

- [ ] All names are clear, descriptive and accurate. Clear naming is preferred over comments

- [ ] Well-named enums are used instead of magic strings and numbers

- [ ] Functions avoid side effects

- [ ] Conditionals should be positive, not negative

- [ ] Methods do not accept more than 3 parameters

- [ ] All methods and classes do just one thing / follow SRP

- [ ] SOLID principles are adhered to

- [ ] All code has passed linting

### Performance and Scalability

- [ ] Reviewer has stepped through all modified code paths using a performance data set to look for performance / memory / CPU usage issues

- [ ] Appropriate data structures have been used

- [ ] async / await is used for I/O bound code paths