-
Notifications
You must be signed in to change notification settings - Fork 114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hacktoberfest-2018 contributions and audits #662
Comments
Looks like Microsoft did a good job encouraging even more contributors to participate. |
|
go-gitea/gitea/pull/5115 |
See you on Hacktoberfest2019 |
This issue is for tracking all
#hacktoberfest
contributions.See https://hacktoberfest.digitalocean.com/eventkit.
Step-by-step instruction:
Register at https://hacktoberfest.digitalocean.com/ by pressing "sign up" and using your github account. You should be able to see your progress at
https://hacktoberfest.digitalocean.com/stats/${username}
(e.g. https://hacktoberfest.digitalocean.com/stats/Quasilyte).Choose Go project to contribute to. Pick any project you like and that seems like an active (last commit have been merged not too long ago). Let's say we've chosen
github.com/foo/bar
project (just an example).Do a
go get -v github.com/foo/bar/...
. This downloads package under your$GOPATH/src/github.com/foo/bar
.Do a
cd $GOPATH/src/github.com/foo/bar
(for convenience).Now run
gocritic
over the project. The suggested way is:gocritic check-project -withExperimental -disable=unnamedResult,appendCombine,importPackageName,nestingReduce,emptyFmt,hugeParam,sqlRowsClose `pwd`
You may want to disable more checkers if they doesn't look useful to you.
5.1 (Optional) If you've spotted an obvious false positive, please fill an issue on gocritic tracker. You can even try to fix that problem yourself, earning another contribution.
Fork a project on the github. Suppose your username is
gosu_pro
, then forked repo can have path likegithub.com/gosu_pro/bar
.From the
$GOPATH/src/github.com/foo/bar
directory do:Now fix problems linter found. It's a good practice to concentrate on the most severe and single check first, packing it into a single commit, to make reviewers life easier. It's OK to send N PRs, every of which fixes only 1 kinds of a problem.
Create a branch with a fixes:
git checkout -b my_fix_1
(you can give a better branch name, for example, a checker name that found an issue).Add and commit changes:
git add -u && git commit
. Write a good commit message. You may want to inspect previous repo commits, so your commit message is consistent with them. Or you can take some inspirations from the linked contributions inside this thread.Push your changes to your fork:
git push fork my_fix_1
.Now you can do a PR (Pull Request) on the github from your fork to the upstream (original) repo.
So, you need to merge
my_fix_1
branch intomaster
(ordev
, depends on the project, but maintainers can always redirect merge branch into something they find more appropriate).(Optional) Write your contribution here! We will be glad to see how gocritic helps you to do open-source, etc.
====
Registration:
Please
Checking your progress:
https://hacktoberfest.digitalocean.com/stats/${username}
For example,
https://hacktoberfest.digitalocean.com/stats/Quasilyte
The text was updated successfully, but these errors were encountered: