github.com/lastbackend/toolkit@v0.0.0-20241020043710-cafa37b95aad/CONTRIBUTING.md (about)

     1  ## How to contribute
     2  
     3  ### Code reviews
     4  
     5  All submissions, including submissions by project members, require review.
     6  
     7  
     8  ==== Coding Style
     9  
    10  1. All code should be formatted with `gofmt`
    11  2. All code should follow the guidelines covered in Effective Go and Go Code Review Comments.
    12  3. Comment the code. Tell us the why, the history and the context.
    13  4. Variable name length should not be too long.
    14  
    15  Great materials to read:
    16  
    17  * https://golang.org/doc/effective_go.html[Effective Go]
    18  * https://blog.golang.org[The Go Blog]
    19  * https://github.com/golang/go/wiki/CodeReviewComments[Code Review Comments]
    20  
    21  Great tools to use:
    22  
    23  - https://github.com/kisielk/errcheck[ErrCheck] - a program for checking for unchecked errors in Go programs.
    24  - https://github.com/golang/lint[GoLint] - a linter for Go source code.
    25  
    26  ==== Reporting issues
    27  
    28  1. Tell us version of Toolkit you use
    29  2. Include the steps required to reproduce the problem, if possible