Contributing (Archived)

DEPRECATED — PROJECT ARCHIVED. the-brain is no longer actively maintained. This page is retained to explain the former contribution process; new contributions and support are not expected.

Historical Contribution Rules

You must understand your code. If you cannot explain what your changes do, a maintainer will ask for clarification before merging.

Using AI to write code is fine. Submitting AI-generated code without understanding it isn't.

Historical Contribution Gate

First-time contributors started with an Issue or Discussion, not a PR. Maintainers replied lgtmi (issues) or lgtm (issues + PRs) to approve. Once approved, contributors could submit PRs directly.

Historical Setup

The source repository remains available for inspection and forking. The former local setup and installation workflow is not supported.

Historical Workflow

The former workflow was fork → feature branch → PR against main. Direct pushes were blocked.

git fetch upstream
git checkout -b feat/your-feature upstream/main

# Write code, following AGENTS.md conventions

bun test --coverage && bun run lint    # must pass
cd apps/docs && bun run build          # docs compile clean

git add <specific-files>               # targeted add only
git commit -m "type(scope): description"
git push origin feat/your-feature

Branch prefixes: feat/, fix/, refactor/, docs/, chore/. Lowercase, hyphen-separated.

Create a changeset to document your changes:

bunx changeset

Before Submitting

• bun test --coverage — >80% line coverage for new code
• bun run lint — zero errors
• cd apps/docs && bun run build — docs compile clean

Philosophy

Core is minimal. New features should be plugins. PRs that bloat the core will likely be rejected. Read PHILOSOPHY.md for the full vision.

See Also

• Project Structure — Monorepo layout
• Testing — Test conventions and isolation patterns
• Writing Plugins — Plugin development guide
• AGENTS.md — Full coding standards
• CONTRIBUTING.md — Historical contributing guide