gh-classroom icon indicating copy to clipboard operation
gh-classroom copied to clipboard

Linting fails after forking and cloning

Open mchisolm0 opened this issue 1 year ago • 1 comments

I was going to fix the error in CONTRIBUTING.md I mentioned in Issue #95. The golangci-lint run command results in the following...

gh-classroom on  main via 🐹 v1.23.6 took 18s ❯ golangci-lint run pkg/classroom/classroom.go:144:21: printf: non-constant format string in call to fmt.Sprintf (govet) return fmt.Sprintf(a.Classroom.Url)

Context

Platform

MacOS Also replicated it on CachyOS Linux (Arch based distro)

Submitting a pull request

  1. [Fork](https://github.com/github/gh-classroom/fork) and clone the repository
    
  2. Configure and install the dependencies: `go mod tidy`
    
  3. Make sure the tests pass on your machine: `go test -v ./...`
    
  4. Make sure linter passes on your machine: `golangci-lint run`       <----- This line causes the error
    
  5. Create a new branch: `git checkout -b my-branch-name`
    
  6. Make your change, add tests, and make sure the tests and linter still pass
    
  7. Push to your fork and [submit a pull request](https://github.com/github/gh-classroom/compare)
    
  8. Please be patient while waiting for your pull request to be reviewed and merged.
    

mchisolm0 avatar Feb 04 '25 22:02 mchisolm0

After doing some more research, I believe the "error" I mentioned is actually the result of a successful run of the lint command.

Clarification

Did these instructions intend to mean...

  1. golangci-lint run should run without any output or with an output saying there are no linting problems?
  2. golangci-lint run should run, successfully outputting any linting problems that need to be addressed?

I thought it was the first one, but I realize the second may be intended. I did not see an issue on the printf problem in the linting output, so I now am thinking the second may be intended. I will continue as if the second is intended unless one of you informs me I am wrong.

Thank you in advance for your time.

mchisolm0 avatar Feb 05 '25 15:02 mchisolm0