Add Hacktoberfest Guides (#4830)

Co-authored-by: taniashiba <126204004+taniashiba@users.noreply.github.com>
2025-09-26 16:03:58 -04:00
parent dc292883b7
commit 5999b786e7
3 changed files with 181 additions and 0 deletions
@@ -7,6 +7,82 @@ We welcome pull requests for general contributions! If you have a larger new fea
 > [!TIP]
 > Beyond code, check out [other ways to contribute](#other-ways-to-contribute)

+--- 
+
+## 🎉 Hacktoberfest 2025 🎉
+
+`goose` is a participating in Hacktoberfest 2025! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone.
+
+### Here's how you can get started:
+
+1. Read the [code of conduct](https://github.com/block/.github/blob/main/CODE_OF_CONDUCT.md).
+2. Skim the quick AI contribution tips below (and see the [full Responsible AI-Assisted Coding Guide](./ai-assisted-coding-guide.md) for details).
+3. Choose a task from this project's Hacktoberfest issues in our [Project Hub](https://github.com/block/goose/issues/4705). Each issue has the 🏷️ `hacktoberfest` label.
+4. Comment ".take" on the corresponding issue to get assigned the task.
+5. Fork the repository and create a new branch for your work.
+6. Make your changes and submit a pull request.
+7. Wait for review and address any feedback.
+
+---
+
+### 🤖 Quick Responsible AI Tips
+
+If you use Goose, Copilot, Claude, or other AI tools to help with your PRs:  
+
+**✅ Good Uses** 
+
+- Boilerplate code and common patterns  
+- Test generation  
+- Docs and comments  
+- Refactoring for clarity  
+- Utility functions/helpers  
+
+**❌ Avoid AI For** 
+
+- Security-critical logic  
+- Complex business rules you don’t understand  
+- Large architectural or schema changes  
+
+**Quality Checklist**  
+
+- Understand every line of code you submit  
+- All tests pass locally  
+- Code follows Goose’s patterns  
+- Document your changes  
+- Ask for review if security or core code is involved  
+
+👉 Full guide here: [Responsible AI-Assisted Coding Guide](./ai-assisted-coding-guide.md)
+
+---
+
+### 🏆 Leaderboard & Prizes
+
+Every hacktoberfest PR and contribution will earn you points on our [leaderboard](https://github.com/block/goose/issues/4775). Those who end up in the top 20 participants with the most points by the end of October will earn exclusive swag and LLM credits! As you have issues merged, here is a brief explanation on how our automatic points system works.
+
+#### Point System
+
+| Weight | Points Awarded | Description |
+|---------|-------------|-------------|
+| 🐭 **Small** | 5 points | For smaller tasks that take limited time to complete and/or don't require any product knowledge. |
+| 🐰 **Medium** | 10 points | For average tasks that take additional time to complete and/or require some product knowledge. |
+| 🐂 **Large** | 15 points | For heavy tasks that takes lots of time to complete and/or possibly require deep product knowledge. |
+
+#### Prizes You Can Win
+
+- **Top 5**: $100 gift card to our [brand new goose swag shop](https://www.gooseswag.xyz/) and $100 of LLM credits!
+- **Top 6-10**: $50 gift cards for goose swag shop and $50 of LLM credits!
+- **Top 11-20**: $25 of LLM credits!
+
+Keep an eye on your progress via our [Leaderboard](https://github.com/block/goose/issues/4775).
+
+### 👩‍ Need help?
+
+Need help or have questions? Feel free to reach out by connecting with us in our [Discord community](https://discord.gg/block-opensource) to get direct help from our team in the `#hacktoberfest` project channel.
+
+Happy contributing!
+
+---
+
 ## Prerequisites

 Goose includes rust binaries alongside an electron app for the GUI. To work