diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d49b7be1ad..863595b3a1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,6 +90,28 @@ file. [monitored by codecov.io]: https://codecov.io/gh/google/go-github [REVIEWERS]: ./REVIEWERS +### Windows users + +Use Git Bash as a terminal or WSL instead of PowerShell. + +To avoid [issues][] with a few linters and formatters within golangci-lint, +make sure you check out files only with LF endings: + +```sh +git config core.autocrlf false +git config core.eol lf +``` + +To convert an existing cloned repo from CRLF to LF, use the following commands: + +```sh +git config core.autocrlf false +git rm --cached -r . +git reset --hard HEAD +``` + +[issues]: https://github.com/golangci/golangci-lint/discussions/5840 + ## Tips Although we have not (yet) banned AI-driven contributions to this repo (as many diff --git a/github/github.go b/github/github.go index a806e7b8030..27ab84e01d5 100644 --- a/github/github.go +++ b/github/github.go @@ -5,7 +5,7 @@ //go:generate go run gen-accessors.go //go:generate go run gen-stringify-test.go -//go:generate ../script/metadata.sh update-go +//go:generate sh ../script/metadata.sh update-go package github