|
| 1 | +# Quick Guide: How Hacktoberfest Works |
| 2 | + |
| 3 | +> Short, practical guide you can add to any repo to help contributors make valid Hacktoberfest PRs. |
| 4 | +
|
| 5 | +--- |
| 6 | + |
| 7 | +## What is Hacktoberfest? |
| 8 | + |
| 9 | +Hacktoberfest is an annual month-long celebration of open source where contributors from around the world make pull/merge requests (PRs/MRs) to public repositories. It’s run in partnership with DigitalOcean, MLH, and community sponsors. |
| 10 | + |
| 11 | +## What counts as a valid contribution? |
| 12 | + |
| 13 | +* A **valid** contribution is a pull/merge request that maintainers accept during the event month. |
| 14 | +* Good contributions include bug fixes, documentation improvements, test coverage, and small features. Avoid trivial or spammy changes. |
| 15 | + |
| 16 | +## Participation goals and rewards |
| 17 | + |
| 18 | +* The community challenge is to make up to **6 accepted PRs/MRs** during the event to reach the top reward tier. |
| 19 | +* Contributors unlock a digital badge as their PRs are accepted. |
| 20 | +* The first limited set of "Super Contributors" (official limit per year) who complete the required accepted PRs may receive special swag. |
| 21 | + |
| 22 | +## How to prepare your repository for Hacktoberfest contributors |
| 23 | + |
| 24 | +1. **Add labels**: `good first issue`, `help wanted`, `documentation`. |
| 25 | +2. **Create a CONTRIBUTING.md** with steps to run the project locally and how to submit PRs. |
| 26 | +3. **Add templates**: Provide an ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE that guides contributors. |
| 27 | +4. **Tag issues** with clear steps and the expected difficulty. |
| 28 | +5. **Mention license & code of conduct** so people know how they can contribute safely. |
| 29 | + |
| 30 | +## A short template for a CONTRIBUTING.md (copy into repo) |
| 31 | + |
| 32 | +``` |
| 33 | +# Contributing to <PROJECT> |
| 34 | +
|
| 35 | +Thanks for your interest! To contribute: |
| 36 | +
|
| 37 | +1. Fork the repo and clone your fork. |
| 38 | +2. Create a branch: `git checkout -b feature/your-short-desc`. |
| 39 | +3. Make changes, add tests if relevant. |
| 40 | +4. Commit with clear messages: `git commit -m "fix: short description"`. |
| 41 | +5. Push and open a PR from your branch: `git push origin feature/your-short-desc`. |
| 42 | +
|
| 43 | +Please read our CODE_OF_CONDUCT.md and ensure changes are helpful and non-spammy. |
| 44 | +``` |
| 45 | + |
| 46 | +## Quick checklist for maintainers reviewing Hacktoberfest PRs |
| 47 | + |
| 48 | +* Is the PR helpful and non-trivial? |
| 49 | +* Does it follow style and tests (if available)? |
| 50 | +* Is there a clear description and linked issue (if applicable)? |
| 51 | +* If you will not accept, politely close with a helpful suggestion. |
| 52 | + |
| 53 | +## Tips for contributors (to make PRs more likely to be accepted) |
| 54 | + |
| 55 | +* Read the project’s README and CONTRIBUTING first. |
| 56 | +* Start with documentation, tests, or labeled `good first issue` tasks. |
| 57 | +* Ask maintainers if you are unsure about scope—use Issues or Discussions. |
| 58 | +* Keep PRs focused and well-documented. |
| 59 | + |
| 60 | +## Suggested `HACKTOBERFEST.md` short blurb for your repo homepage |
| 61 | + |
| 62 | +``` |
| 63 | +We welcome Hacktoberfest contributions! If you'd like to help, look for issues with `good first issue` or `hacktoberfest` labels. Follow CONTRIBUTING.md before opening a PR. |
| 64 | +``` |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +### How to use this file |
| 69 | + |
| 70 | +* Copy this markdown into `HACKTOBERFEST_QUICKGUIDE.md` (or add into `CONTRIBUTING.md`) and open a PR. |
| 71 | +* If you want, I can tailor the guide to your specific repo (commands to run, dev setup, recommended starter issues). |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +*Created to help maintainers welcome Hacktoberfest contributors with clear expectations.* |
0 commit comments