Add linters in github action

[jaydeluca]

Rainy Day low priority issue to keep things clean

• [x] Kotlin linting for orders api
• [ ] Golang linting for users api
• [ ] terraform linting for all terraform directories

[chinmay-panchal]

Hello, I want to contribute. please tell me, how can i start? i am new into open source.

[jaydeluca]

hey @chinmay-panchal !

Are you familiar with github actions? The task here will be to implement linters, you can start with the kotlin and golang applications if you are interested. ktlint would be a good one for the kotlin app (under the api directory), or go linting for the users-api folder.

You will need to add the appropriate github actions code, as well as fix anything that then fails the linting rules. Let me know if you need any additional context

[chinmay-panchal]

@jaydeluca I know the commands of github, i know how to make a pull request, but sir i want to know how to know what the issue is and how can i started with the issue?

[jaydeluca]

Github actions are not the same thing as github commands, they are a feature that github provides to run workflows: https://docs.github.com/en/actions

This project already has some configured for the two apis: https://github.com/jaydeluca/sre-lab/tree/master/.github/workflows

Currently the workflows only build the projects to ensure everything compiles. The task would be to add additional steps to run linters as well. Since this will be the first introduction of linting, there might be a significant amount of code that is not compliant, and that will need to be fixed as well.

For the orders api, it could be as simple as including ktlint in the existing gradle build job, or we can have it run as a separate task https://github.com/pinterest/ktlint

For the users api you could explore using: https://github.com/golangci/golangci-lint