Codewhale
GitHub
Contribute to an international open-source project

Start with one concrete improvement.

Codewhale welcomes contributors across countries, languages, platforms, and experience levels. Clear bug reports, reproduction results, documentation corrections, translations, and small complete patches all move the project forward.

File an issueBrowse pull requestsOpen the full contributor guide
Ways to help now

Choose the contribution that fits.

Report a bug or compatibility problem

Include your system, Codewhale version, reproduction steps, expected behavior, and any logs you can share safely.

File an issue →

Improve code or tests

Choose a well-bounded problem, make the smallest useful patch, and add a regression test that proves the changed behavior.

Browse open issues →

Improve documentation or translations

Correct inaccurate guidance, add a practical example, or help a complete language pack stay natural and aligned with the English keys.

Read the localization guide →

Reproduce and review existing work

Verify an issue or pull request with your platform and provider, then share the exact checks and results.

Browse pull requests →
Pull request workflow

From a problem to a reviewable patch.

  1. 01

    Choose one clear problem

    Browse open issues, especially good first issue and help wanted. If the behavior is not tracked yet, open an issue with a reproduction before starting a large change.

    Browse open issues →
  2. 02

    Fork and create a branch

    Clone your fork and use a short branch name such as fix/provider-timeout or docs/fleet-example. Keep unrelated changes in separate pull requests.

    Open the repository →
  3. 03

    Test the behavior you changed

    Run the smallest relevant test first, then formatting and the broader checks required for the part of the repository you touched.

    Read the contributor guide →
  4. 04

    Explain the result in the PR

    Describe the problem, the reason for the change, the checks you ran, and any remaining risk. Link the issue when one exists.

    View open pull requests →
Prepare for review

Make the change easy to verify.

A reviewer needs the problem, the reason for the change, test evidence, and remaining risk. Clear scope usually leads to clearer feedback.

  • Keep one problem per pull request so the change is easy to test, review, and credit.
  • Add tests for new behavior. For documentation fixes, verify commands, configuration names, and the current version against the repository.
  • Open an issue before changing authentication, credentials, sandbox policy, release plumbing, branding, or global prompts.
  • If a maintainer needs to adapt or harvest a patch, the original contributor remains credited in the commit, changelog, and contributor list.
Local development

Build and run the relevant checks.

The repository uses stable Rust. Run the focused test for your change first, followed by formatting, Clippy, and the workspace suite.

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