Technical idea: Introducing CodeReview checklist

[kaluginserg]

Why

1. Ensuring Code Quality and Readability: A Code Review checklist can help developers identify issues related to code quality, such as inconsistent code style, poor naming conventions, or improper use of programming constructs. By following a checklist, reviewers can ensure that the code is clean, easy to understand, and maintainable for future updates.

2. Detecting and Preventing Bugs: A well-designed Code Review checklist can help reviewers spot potential bugs or issues in the code that might have been overlooked during development. This can include logic errors, potential security vulnerabilities, or performance bottlenecks. Catching these issues early in the review process can save time and resources by reducing the number of issues that need to be addressed after deployment.

3. Encouraging Knowledge Sharing and Collaboration: A Code Review checklist can serve as a framework for constructive feedback and discussions between team members. By using a checklist, reviewers can encourage best practices and share knowledge about new techniques or approaches in solving specific problems. This collaborative process can help foster a positive team culture and improve overall software development processes.

Check list proposal:

1. Coding standards and style guides. TODO add link with description.

2. Verify that the code meets the requirements.

3. Clear and Comprehensive Documentation (Typescript, JSComments for complex logic, .md files).

4. Tests for the functionality and test code quality. TODO Define the rules.

5. Error handling and exception management. TODO add link with description (using assert library, using throw error).

6. Extensibility, Modularity, and Interoperability. As we build OpenSource Library (not just a business project)

7. Code quality. (Solid, YANGI)

8. Performance and efficiency. TODO Define the rules.

9. Use of appropriate design patterns and best practices specific for Ketcher. TODO Define the rules.

10. Cross-browser compatibility in mind. TODO Define the rules.

??? Something else

Next steps

• define the list items
• prioritise them
• introduce to team
• integrate to everyday code review process

[kaluginserg]

@AnastasiiaPlyako @yuleicul @Nitvex @rrodionov91 - any suggestions/ideas? ^^^