mattermost/mattermost

Fix all initialism errors in the codebase

Open

#16,623 opened on Jan 4, 2021

View on GitHub
 (27 comments) (0 reactions) (1 assignee)TypeScript (32,880 stars) (7,823 forks)batch import
Difficulty/1:EasyGood First IssueHacktoberfestHelp WantedTech/Go

Description

Summary

This ticket is about fixing any variable naming issues that do not follow the initialism convention as laid out in: https://github.com/golang/go/wiki/CodeReviewComments#initialisms.

The way to go about it would be to make the following change to .golangci.yml

diff --git a/.golangci.yml b/.golangci.yml
index 29d9a4622..662931923 100644
--- a/.golangci.yml
+++ b/.golangci.yml
@@ -49,7 +49,7 @@ issues:
 
     - linters:
       - golint
-      text: "should have|should be|should replace|stutters|underscore|annoying|error strings should not be capitalized"
+      text: "should replace|stutters|underscore|annoying|error strings should not be capitalized"
 
     - linters:
       - golint

And then fix all issues that arise until make golangci-lint passes with no errors.

Contributor guide

Tech stack
go
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Enable the 'golint' linter rule to report initialism errors by modifying .golangci.yml (removing the exclusion), then run golangci lint and fix all reported issues. The file .golangci.yml is at the root of the repository. After fixing, ensure make golangci lint passes.