mercadolibre / chico

A collection of easy-to-use UI components.
http://chico.mercadolibre.com
MIT License
343 stars 87 forks source link

Code Quality config files #1355

Closed miporto closed 3 years ago

miporto commented 3 years ago

Hello from the Code Quality Bot!!! ๐Ÿ‘‹

We are opening this pull request to let you know that from now on all Java repositories will have the Code Quality Service configuration files in them.

Why are you opening this pull request in the first place? ๐Ÿคจ

We are doing this as part of the announced changes in Code Quality Service. These changes aim to ease the running of the service locally, its integration in your code editors, IDEs and as part of your Git workflow (by adding the check as a pre-commit hook).

You can find more information about these changes in our last announcement.

What is the purpose of these files you are adding to my repository? ๐Ÿค”

This pull request adds the necessary files for Code Quality Service to function in your application. These configuration files reside inside the directory .code_quality. It is very important that you don't modify nor move any of the files under this directory. The service will check that all files exist and are in sync (not modified in any way).

We are also adding the following file: .pre-commit-config.yaml. Although not necessary for the functioning of the service, this file will help you to run all quality checks before committing new or modified files in your repository. We strongly recommend that you use it as it is provided to you.

It is very important that you merge this pull request since these files will be required for the service for proper functioning.

Do these changes include the autofix feature? ๐Ÿช„

Yes! We've added the configuration file for using Black. The autofix tool that Code Quality offers you for fixing some common styling issues in your code. For configuring it and using it please refer to this and this sections.

I want to know more! ๐Ÿค“

We invite you to check our renewed documentation about the service. For information about configuring it for running Code Quality locally, please refer to the Using the Service section.

Created by Sourcegraph batch change manuporto/open-cq-java-prs-test-3.