Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (63 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 3.53 KB
Raw

Contributing to Branda

Thanks for your interest in contributing! Branda is an open-source project by the Context.dev team, and we welcome contributions of all sizes — bug fixes, new ad formats, better prompts, docs, anything.

By participating, you agree to follow our Code of Conduct.

Getting set up

  1. Fork and clone the repo:

    git clone https://github.com/<your-username>/ad-maker.git
cd ad-maker
npm install

  2. Configure your environment:

    cp .env.example .env

    You'll need:

  3. Run the dev server:

    npm run dev

    Open http://localhost:3000, paste a public domain, and make sure generation works end to end before you start changing things.

Making changes

  • Create a branch from main: git checkout -b feat/my-feature (or fix/..., docs/...)

  • Keep PRs focused on a single change — small PRs get reviewed and merged fastest

  • Match the existing code style: TypeScript, App Router conventions, Tailwind for styling

  • Before pushing, run the complete verification gate:

    npm run verify

Where things live

Use the domain names and relationships defined in CONTEXT.md when changing an interface or moving behavior between modules.

Area Path
Shared Ad Run contract src/lib/ad-run.ts
Brief planning src/lib/generate/planner.ts, src/lib/generate/brief.ts
Rendered Ad generation src/lib/generate/renderer.ts
Creative Direction catalog + prompts src/lib/generate/directions.ts, src/lib/generate/concepts.ts
Image Model catalog src/lib/generate/models.ts
Public raster-logo policy src/lib/public-raster.ts
Context.dev integration src/lib/context.ts
UI src/components/ad-maker.tsx, src/hooks/use-ad-maker.ts

Adding a new creative direction

  1. Add its key, label, and bestFor metadata to CREATIVE_DIRECTIONS in src/lib/generate/directions.ts
  2. Add the matching prompt implementation in src/lib/generate/concepts.ts; the exhaustive registry reports a type error if one is missing
  3. Reuse the shared typography(...) and HARD_RULES blocks so text stays clean
  4. Never put hex codes in a prompt — use the colorA/colorB phrases (image models literally print hex strings onto the art)

Swapping image models

Edit IMAGE_MODELS in src/lib/generate/models.ts. Each Image Model record declares its primary/secondary tier and whether it accepts a raster logo; the shared contract verifies six distinct assignments and primary-first placement.

Opening a pull request

  • Describe what changed and why
  • Include screenshots or generated ads for anything visual — they make review much faster
  • Link any related issues

Reporting bugs & suggesting features

Open an issue with:

  • What you did (the domain you pasted, if relevant)
  • What you expected vs. what happened
  • Any errors from the browser console or dev server output

Never include your API keys in issues, logs, or screenshots.

Please report suspected vulnerabilities privately using the process in SECURITY.md, not in a public issue.

License

By contributing, you agree that your contributions will be licensed under the MIT License.