HOWTO - Contributors
Advice for Hackertoberfest First Timers and Noobs:⌗
Welcome!⌗
Thanks for choosing to work on open source code. You may be motivated by personal development, a career in programming, or a really awesome customized digital badge. All of these are valid reasons. There are other reasons too, including “because I felt like it”, and that’s OK, too.
Looking for issues:⌗
There are a variety of places to look for new issues, but they aren’t always friendly.
Spam⌗
Your pull/merge requests must not be spammy. For example:
- Automated PR/MRs: scripted opening pull requests to remove whitespace, fix typos or optimize images.
- Disruptive PR/MRs: taking someone else’s branch/commits and making a pull request.
- Anything that a project maintainer flags as spam.
- Anything that looks like an attempt to duplicate your pull request count for October.
- Multiple PR/MRs for the same issue that are unnecessary - for example five PR/MRs to remove a stray whitespace.
PR/MRs that are labeled with a label containing the word “spam” by maintainers will not be counted towards Hacktoberfest.
PR/MRs that the Hacktoberfest system detects as spammy will also not be counted. (It uses the Node.js RegEx engine with
/\bspam\b/i
to look for spam labels.)
Any user with two or more spammy PR/MRs will be disqualified from Hacktoberfest.
Looking for additional swag?⌗
Some companies will post additional swag opportunities, but you may have to work a little bit extra to get those benefits. A good place to look for places that are offering additional stuff is the Hacktoberfest Swag List. Feel free to check that out if you’re feeling adventurous.
It can be useful to define what level of commitment you’re looking to make in picking up an issue. Possible places you spend time working on an issue include:
- Reading the issue itself
- Understanding what the heck they want.
- Asking clarifying questions in the issue discussion
- Communicating that you intend to work on this issue to the repo owner(s)
- Figuring out which file or files need to be opened to figure out the solution.
- Trying, potentially failing, trying again, lather, rinse, repeat.
- Creating the solution.
- Testing your solution.
- Committing your changes and giving the commit a descriptive name
- Opening up a pull request
- Discussing your pull request
- Potentially make changes to your pull request.
- Doing a happy dance if your pull request is accepted.
The more you do the above actions, the more quickly you can accomplish these things. For your first issue, plan on at least a couple minutes to accomplish each task in the above list in order to keep from getting too discouraged. If you already know the solution to the issue, make sure you still plan on spending time communicating with the repo owners about the work you plan to do.
Depending on the level of programming experience you have, it might be good to set a goal of spending approximately 1 hour per Hacktoberfest Pull Request, not including wading through all of the issues. Hopefully, you find a cool repo with a helpful owner that makes this process smooth and empowering, not painful and toxic. If you don’t find issues right away, don’t fret! You CAN make your repositories, and create your own issues. Then, you can use the valuable experience of having looked through a bunch of GitHub issues to write clearly defined, achievable issues that you and others can work on.
You can do this!⌗
Remember, contributing to open source should be fun and fulfilling, so if you’re discouraged, take a break. Go and take a walk, play a game, or interact with people you care about, and come back to it when you’re feeling recharged and motivated.