armada icon indicating copy to clipboard operation
armada copied to clipboard

Update documentation to describe what linters/tools are recommended for development for go

Open kannon92 opened this issue 2 years ago • 6 comments

Currently, we use golangci as our linter. We should update our documentation to explain how to setup the linter and how to integrate with an editor.

https://golangci-lint.run/ is the linter we use.

kannon92 avatar Sep 01 '22 15:09 kannon92

The documentation should include the following:

  1. How to install the linter (linux/mac)
  2. Setting up the linter in commonly used editors (VSCode, JetBrains, ...)
  3. Process for adding/removing a new linter
    • This process should include an issue to add/remove the linter.
    • PR should fix the linter so it passes in the CI

kannon92 avatar Sep 02 '22 14:09 kannon92

Hey, can i be assigned to this? i would like to help

lazyturd avatar Sep 05 '22 13:09 lazyturd

Hey @lazyturd, Thank you for picking this up. And Welcome to Armada!

Please let us know if you have any questions.

kannon92 avatar Sep 05 '22 14:09 kannon92

Hey team! Please add your planning poker estimate with Zenhub @dejanzele @jayofdoom @kannon92 @richscott

dave-gantenbein avatar Sep 06 '22 15:09 dave-gantenbein

Please add your planning poker estimate with Zenhub @suprjinx

dave-gantenbein avatar Sep 06 '22 15:09 dave-gantenbein

@lazyturd Hello! Our team was discussing issues and there is some internal issues we will have to address. I suggest taking a different issue if you are still interested in contributing.

kannon92 avatar Sep 06 '22 15:09 kannon92