|
1 | 1 | # Hacktoberfest |
2 | 2 |
|
3 | | -- Repo topics include `hacktoberfest` |
4 | | -- Label `Hacktoberfest` exists |
5 | | -- Good first issues: look for `good first issue` |
| 3 | +Hacktoberfest is a good time to contribute to the Create Python App ecosystem, especially if you want a small, well-scoped task. The fastest way to get started is to pick a repo, scan for the right labels, and read the contributor guide before opening a PR. |
| 4 | + |
| 5 | +## Repositories newcomers can help with |
| 6 | + |
| 7 | +| Repository | Good task types | |
| 8 | +| --- | --- | |
| 9 | +| [create-python-app](https://github.com/Create-Python-App/create-python-app) | CLI bug fixes, docs polish, fixture/test improvements, release notes, contributor experience work | |
| 10 | +| [cpa-templates](https://github.com/Create-Python-App/cpa-templates) | Template improvements, example updates, extension polish, catalog metadata fixes | |
| 11 | +| [website](https://github.com/Create-Python-App/website) | Landing page copy, docs navigation, examples, small UI polish | |
| 12 | +| [taps](https://github.com/Create-Python-App/taps) | Packaging/documentation improvements, workflow tweaks, examples | |
| 13 | + |
| 14 | +## Labels to look for |
| 15 | + |
| 16 | +- `good first issue` for small, low-risk tasks |
| 17 | +- `help wanted` when a maintainer is actively looking for contributions |
| 18 | +- `Hacktoberfest` for seasonal issues that are a good fit for the event |
| 19 | + |
| 20 | +## How to search for a task |
| 21 | + |
| 22 | +- Start with the repository's Issues tab and filter by one of the labels above. |
| 23 | +- Read the issue description, acceptance criteria, and linked discussion before you comment. |
| 24 | +- Prefer tasks that are clearly scoped, have an obvious next step, and do not depend on private access. |
| 25 | +- If you are not sure where to begin, ask in Discord or open a short note on the issue to say you are reviewing it. |
| 26 | + |
| 27 | +## Before you start |
| 28 | + |
| 29 | +- Read [CONTRIBUTING.md](../CONTRIBUTING.md) first so you know the local workflow and expected PR style. |
| 30 | +- Join the community Discord for quick questions and coordination: [Discord](https://discord.gg/bR5VyATgka) |
| 31 | +- If you are considering an assigned epic such as AI/ML catalog work, avoid duplicating it casually. Confirm the issue is still open and ask in Discord or on the issue thread before you start a parallel effort. |
| 32 | + |
| 33 | +## Suggested first tasks |
| 34 | + |
| 35 | +- Fix a typo or clarify a setup step in the docs |
| 36 | +- Add or improve a test for a CLI or scaffolding edge case |
| 37 | +- Help triage a small bug report or reproduce an issue locally |
| 38 | +- Improve template metadata or examples in a repo that already has a clear scope |
| 39 | +- Update release notes, changelog wording, or contributor-facing examples when they are clearly incomplete |
| 40 | +- Add a small regression test for a fixture or catalog path that is currently undocumented or brittle |
| 41 | + |
| 42 | +## What to avoid |
| 43 | + |
| 44 | +- Do not duplicate an assigned epic just because it looks similar to another issue. |
| 45 | +- Avoid large rewrites unless the issue explicitly asks for them or a maintainer has agreed to the scope. |
| 46 | +- Skip tasks that require private context, deployment access, or a broad architectural decision without guidance. |
| 47 | + |
| 48 | +A good rule of thumb is to choose a task that is small enough to finish in one PR and clearly linked to an existing issue or discussion. |
0 commit comments