-
Notifications
You must be signed in to change notification settings - Fork 57
Description
If you landed here because you're participating in Hacktoberfest this issue contains everything you need to know about kr8s and Hacktoberfest.
Finding something to work on
We have a bunch of issues labelled with help wanted. This is the best place to start. I've also tried to use good first issue, good second issue, good expert issue to give an idea of difficulty.
Please don't comment on issues asking if you can take them. Start a draft PR and begin iterating, then mark ready for review once you have something complete. This helps me give feedback early and often, which is much more valuable for everyone involved.
Want to work on documentation instead of coding? Take a look at the examples and guides sections. We can never have enough of these, so if you have ideas for new examples we can add please feel free to make a PR.
Submission guidelines
Every PR opened requires time and attention from someone to review it. Hacktoberfest aren't rewarding the maintainers for their review time, only participants for their PRs, so please be respectful towards maintainers.
Based on past experience reviewing Hacktoberfest PRs here are a few rules:
- PRs that make small docs changes but do not actually improve the documentation will be marked as spam
- Your PR should address an open issue, if you want to work on something else please open an issue first
- Feel free to use AI tools, but review the generated code yourself first! Only submit code you would happily put your name on. PRs that are purely vibe coded will be marked as spam.
Additional swag
If you submit a particularly good PR that improves the project I will send you kr8s stickers (provided I can post to your country from the UK Post Office). What qualifies for a "particularly good PR" is at the discretion of @jacobtomlinson.
Happy coding!