ColoredCow / portal

A hub-and-spoke platform for organizations to effectively manage their operations and data. Uses GSuite.
MIT License
55 stars 51 forks source link

Integrate automated checks for code review. #3392

Open deepakbarmola opened 8 months ago

deepakbarmola commented 8 months ago

Describe the task Need to apply coding sanity checks to detect coding flaws beforehand.

image image

NOTE : Above mentioned checks are not yet implemented on pre-commit.

Expected behaviour While committing the PR, automated checks should catch the coding flaws and report back.

Ayush8923 commented 8 months ago

As per the last discussion with the team, we are planning to make the new portal from scratch, and we have already one document of the code review process guideline Pankaj has already worked on the review process and refactored this existing code review process.

Here is the document of the code review process. https://docs.google.com/document/d/1Sa-XYJEmGwrOM5gk5zoan_Z6j90ylibmCmt331361nw/edit A red line comment has been added to this document for all the things that can be reviewed with the help of the tool.

If the discussion is complete on whether we are making the new portal or not then we will start working on these tools for the project.

CC: @Sachinbisht27 @Abhinegi2

deepakbarmola commented 8 months ago

Hi @pankaj-ag @Ayush8923 @Sachinbisht27 it would be helpful if we can link the doc here in which details like what all tools are integrated and what checks are available at what steps?

deepakbarmola commented 7 months ago

As per discussion with @pankaj-ag @Ayush8923 @Sachinbisht27

It is not suggested to implement all the checks on pre-commit, reason being if a developer submits commit frequently he/she has to wait for all the checks to pass and time might can go upto 10 minutes or more if we add too many checks hence we can keep few basic checks on pre-commit and keep all the checks on PR creation.