-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Add Hacktoberfest Guides #4830
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add Hacktoberfest Guides #4830
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Responsible AI-Assisted Coding Guide | ||
| _Guidelines for contributing responsibly to goose during Hacktoberfest_ | ||
|
|
||
| goose benefits from thoughtful AI assisted development, but contributors must maintain high standards for code quality, security, and collaboration. Whether you use goose, Copilot, Claude, or other AI tools, these principles will help you avoid common pitfalls. | ||
|
|
||
| --- | ||
|
|
||
| ## Core Principles | ||
|
|
||
| - **Human Oversight**: You are accountable for all code you submit. Never commit code you don’t understand or can’t maintain. | ||
| - **Quality Standards**: AI code must meet the same standards as human written code—tests, docs, and patterns included. | ||
| - **Transparency**: Be open about significant AI usage in PRs and explain how you validated it. | ||
|
|
||
| --- | ||
|
|
||
| ## Best Practices | ||
|
|
||
| **✅ Recommended Uses** | ||
|
|
||
| - Generating boilerplate code and common patterns | ||
| - Creating comprehensive test suites | ||
| - Writing documentation and comments | ||
| - Refactoring existing code for clarity | ||
| - Generating utility functions and helpers | ||
| - Explaining existing code patterns | ||
|
|
||
| **❌ Avoid AI For** | ||
|
|
||
| - Complex business logic without thorough review | ||
| - Security critical authentication/authorization code | ||
| - Code you don’t fully understand | ||
| - Large architectural changes | ||
| - Database migrations or schema changes | ||
|
|
||
| **Workflow Tips** | ||
|
|
||
| - Start small and validate often—build, lint, and test incrementally | ||
| - Study existing patterns before generating new code | ||
| - Always ask: “Is this secure? Does it follow project patterns? What edge cases need testing?” | ||
|
|
||
| **Security Considerations** | ||
|
|
||
| - Extra review required for MCP servers, network code, file system ops, user input, and credential handling | ||
| - Never expose secrets in prompts | ||
| - Sanitize inputs/outputs and follow goose’s security patterns | ||
|
|
||
| --- | ||
|
|
||
| ## Testing & Review | ||
|
|
||
| Before submitting AI assisted code, confirm that: | ||
| - You understand every line | ||
| - All tests pass locally (happy path + error cases) | ||
| - Docs are updated and accurate | ||
| - Code follows existing patterns | ||
|
|
||
| **Always get human review** for: | ||
|
|
||
| - Security sensitive code | ||
| - Core architecture changes | ||
| - Async/concurrency logic | ||
| - MCP protocol implementations | ||
| - Large refactors or anything you’re unsure about | ||
|
|
||
| --- | ||
|
|
||
| ## Using goose for goose Development | ||
|
|
||
| - Protect sensitive files with `.gooseignore` (e.g., `.env*`, `*.key`, `target/`, `.git/`) | ||
| - Guide Goose with `.goosehints` (patterns, error handling, formatting, tests, docs) | ||
| - Use `/plan` to structure work, and choose modes wisely: | ||
| - **Chat** for understanding | ||
| - **Smart Approval** for most dev work | ||
| - **Approval** for critical areas | ||
| - **Autonomous** only with safety nets | ||
|
|
||
| --- | ||
|
|
||
| ## Community & Collaboration | ||
|
|
||
| - In PRs, note significant AI use and how you validated results | ||
| - Share prompting tips, patterns, and pitfalls | ||
| - Be responsive to feedback and help improve this guide | ||
|
|
||
| --- | ||
|
|
||
| ## Remember | ||
|
|
||
| AI is a powerful assistant, not a replacement for your judgment. Use it to speed up development; while keeping your brain engaged, your standards high, and goose secure. | ||
|
|
||
| Questions? Join our [Discord](https://discord.gg/block-opensource) or [GitHub Discussions](https://github.com/block/goose/discussions) to talk more about responsible AI development. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the shop link I forgot to share! Looks great otherwise c: