Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 1.96 KB
Raw

Contributing

Adadex is an experimental personal project and is not actively reviewing pull requests right now. If you still open one, keep changes small, test-backed, and easy to review.

Before you change anything

  • read the relevant docs in docs/
  • check whether the behavior already exists in the API or UI before adding more surface area
  • keep the project Codex-first in docs and product framing
  • do not document speculative features as if they already work

Prerequisites

  • Node.js 22+
  • pnpm
  • codex for the supported agent workflow
  • git for worktree features

Setup

pnpm install

Development

pnpm dev

The dev runner starts the local API and web app together.

Required checks

Run these before opening a pull request:

pnpm test
pnpm lint
pnpm build

Use pnpm format if you need to rewrite formatting.

What good contributions look like

  • incremental changes with clear scope
  • tests for behavior changes
  • docs updated in the same change when workflows or concepts change
  • code and docs that reflect the current implementation, not a roadmap

Docs policy

  • docs/ is for contributor and future-agent understanding
  • if you change coordinations, todos, terminals, orchestration, or messaging, update the matching docs page

Pull request expectations

  • understand that pull requests are not actively reviewed right now
  • explain the problem in one short paragraph
  • explain the behavior change in concrete terms
  • mention any persistence, API, or workflow impact
  • include screenshots for visible UI changes
  • disclose which coding agent and model were used if any code was written with AI
  • call out missing follow-up work explicitly instead of hiding it

Areas that matter most right now

  • coordination model and agent-facing context files
  • todo parsing and delegation flow
  • agent terminal lifecycle
  • child-agent orchestration
  • inter-agent messaging
  • fixing existing issues and optimize for reliability