参与国际开源社区

从一个具体的改进开始。

无论你来自哪个国家、使用哪种语言和平台、经验多少，都可以参与贡献。清楚的 bug 报告、复现结果、文档修正、翻译和小而完整的补丁都算数。

提交 issue查看 pull requests打开完整贡献指南

选择适合你的贡献方式。

报告 bug 或兼容性问题

提供系统信息、Codewhale 版本、复现步骤、期望行为和可公开的日志。

提交 issue

改进代码或测试

选择一个边界清楚的问题，提交最小补丁，并用回归测试证明修改后的行为。

查看待处理 issues

改进文档或翻译

修正不准确的说明、补充实际示例，或帮助完整语言包保持自然且与英文键一致。

阅读本地化指南

复现和审查现有工作

验证 issue 或 pull request 在你的平台和提供商上的行为，并分享准确的测试结果。

浏览 pull requests

从问题到可审查的补丁。

  1. 选择一个明确的问题

    先浏览 open issues，尤其是 good first issue 和 help wanted。如果问题尚未记录，请在开始大改动前提交带复现步骤的 issue。

    浏览 open issues

  2. Fork 并创建分支

    克隆你的 fork，并使用简短的分支名，例如 fix/provider-timeout 或 docs/fleet-example。无关修改请拆成不同的 pull request。

    打开仓库

  3. 测试你修改的行为

    先运行最小相关测试，再执行格式检查和你所修改部分需要的更完整检查。

    阅读贡献指南

  4. 在 PR 中说明结果

    说明问题、修改原因、已运行的检查和剩余风险；如果已有 issue，请在 PR 中关联。

    查看 open pull requests

让修改容易验证。

把问题、修改理由、测试证据和剩余风险交给审查者。范围越集中，反馈越清楚。

  • 一个 PR 只解决一个问题，便于测试、审查和保留贡献者署名。
  • 新增行为应有测试；修正文档时，请核对实际命令、配置名和当前版本。
  • 修改认证、凭据、沙箱、发布流程、品牌或全局提示词前，请先提交 issue 并确认范围。
  • 如果维护者需要整理或摘取补丁，原作者仍会在提交、CHANGELOG 和贡献者名单中获得署名。

构建并运行相关检查。

仓库使用 stable Rust。先运行你所修改部分的测试，再运行格式检查、Clippy 和完整工作区测试。

git clone https://github.com/YOUR_USERNAME/CodeWhale.git
cd CodeWhale
git checkout -b fix/your-change

cargo build
cargo test -p <owning-crate> --locked
cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features --locked -- -D warnings
cargo test --workspace --all-features --locked

献给一起构建 Codewhale 的人

贡献者周边按成本提供。填写 GitHub 用户名、数字用户 ID 或贡献链接。

查看贡献者周边