Skip to content

Open-source Grok Bot alternative for named AI teammates. Local-first desktop, web, and mobile clients with per-bot tools, instructions, and memory. Independent fork of T3 Code.

3.0 KB
Raw Blame

Contributing

Read This First

We are not actively accepting contributions right now.

You can still report a bug or open a PR, but please do so knowing there is a high chance we close it, defer it forever, or never look at it.

Feature requests and proposals belong in Akeru Bot Ideas discussions, not issues. Plugin and provider contributions are the exception. Start with the plugin proposal or provider proposal. Read the plugin directory admission rules before you submit a plugin.

If that sounds annoying, that is because it is. This project is still early and we are trying to keep scope, quality, and direction under control.

PRs are automatically labeled with a vouch:* trust status and a size:* diff size based on changed lines.

If you are an external contributor, expect vouch:unvouched until we explicitly add you to .github/VOUCHED.td.

What We Are Most Likely To Accept

Small, focused bug fixes.

Small reliability fixes.

Small performance improvements.

Tightly scoped maintenance work that clearly improves the project without changing its direction.

What We Are Least Likely To Accept

Large PRs.

Drive-by feature work.

Opinionated rewrites.

Anything that expands product scope without us asking for it first.

If you open a 1,000+ line PR full of new features, we will probably close it quickly and remember that you ignored the clearly written instructions.

If You Still Want To Open A PR

Keep it small.

Explain exactly what changed.

Explain exactly why the change should exist.

Do not mix unrelated fixes together.

If the PR makes anything resembling a UI change, include clear before/after images.

If the change depends on motion, timing, transitions, or interaction details, include a short video.

If we have to guess what changed, we are much less likely to review it.

Every pull request must also record its release decision. Run pnpm changeset, select one of the Akeru product packages, and write a short user-facing summary. Use patch for compatible fixes, minor for compatible features, and major only for a breaking change. The product packages ship as one fixed-version release train, so selecting one is enough. For documentation, tests, refactors, and internal-only tooling, run pnpm changeset --empty. CI rejects pull requests that omit this decision.

Discuss Changes First

If you are thinking about a non-trivial change, start a discussion first. Issues are reserved for bug reports and the plugin and provider proposal forms.

That still does not mean we will want the PR, but it gives you a chance to avoid wasting your time.

Be Realistic

Opening a PR does not create an obligation on our side.

We may close it. We may ignore it. We may ask you to shrink it. We may reimplement the idea ourselves later.

If you are fine with that, proceed.