Fix go lint issues highlighted in Go report Card

[dharmjit]

Go Report Card Results for go lint is only 56%. Most of these are for exported fields/methods not having comments. We need to fix these lint issues.

[raunaksingwi]

I can take this one

[anusha94]

/assign raunaksingwi

[jayesh-srivastava]

Hi. Was wondering if @raunaksingwi is still working on this issue. If not then I would like to work on this.

[anusha94]

/unassign @raunaksingwi
/assign @jayesh-srivastava

Thanks for picking it up @jayesh-srivastava !

[anusha94]

Hey @jayesh-srivastava !
Let us know if you need any assistance.

[jayesh-srivastava]

Hi @anusha94 I was working on the issue. There are a lot of files that need modifications. I was thinking of making multiple PRs for different packages as it would be then easier to review. Any thoughts?
Or maybe several commits for the same PR would help too.

[anusha94]

@jayesh-srivastava
That sounds good!

[jayesh-srivastava]

Also @anusha94 a lot of issues regarding this are related to structs and functions not having comments. I'll have to manually do this because there is no autofix for golint. How should I do this because to know what each structs and functions do, that is a nearly impossible task I guess.

exported type ScriptExecutor should have comment or be unexported
comment on exported type IFileWriter should be of the form "IFileWriter ..." (with optional leading article)

These are some examples of the issues coming up. Am I able to understand it the right way?

[anusha94]

@jayesh-srivastava that's a fair call-out. I haven't taken a look at the lint errors myself. But from the issue description, it's indeed mostly comments.
I can create a task list for this issue for different categories of lint errors. Probably then it will be easier for you to work on a subset of these tasks?
One of us on the byoh team can work on the missing comments.

[jayesh-srivastava]

@anusha94 That would work. I guess 99 percent of the issues are only comments. The ones which are not, I'll work and make the PR for it. The ones with the comment, maybe I can assist anyone on the byoh team who'll be working on this as the number of issues are a lot.