Reviewing community solutions to projects
Code review is an essential part of modern engineering teams. While we don't support a traditional code review workflow DevProjects, we do strongly encourage you share your project solutions. This way, community members can review your code, ask questions, and learn from the technical decisions you've made. We also encourage you to do the same for others!
We've also designed a "quick feedback" section for each project solution. This includes factors that developers will usually take into account during code reviews. We've taken inspiration from how development teams at companies like Google and GitLab run code reviews.
You can give encouragement to the code author by letting them know they've done well on any (or all!) of the following:
- Functionality: Does the code behave as the author likely intended?
- Naming: Did the developer choose clear names for variables, classes, methods, etc.?
- Tests: Does the code have correct and well-designed automated tests?
- Simplicity: Is the code in its simplest form? Would another developer be able to easily understand this code?
- Style: Does the code have consistent style? Is it easy to understand?
If you'd like to learn more about code reviews in a team context, Why code reviews matter from Atlassain gives a great overview.