Guides

Contributing

The rules a program file must pass, and how to correct one.

Add a program by pull request

  1. Fork Affitor/open-affiliate.
  2. Add programs/<slug>.yaml, one program per file, named with its slug. The YAML Schema page has a template.
  3. Open a pull request to main and put the link to the brand's program page in its description.
  4. Automatic checks run, then a maintainer compares every term with the program page. Reviews usually take a few days.

Not a developer? Use the submit form or the other ways on Submit a Program.

Rules a file must pass

  • Required: name, slug, url, category (one of the schema's 20 values), commission.type, commission.rate, commission.mode, description, short_description (100 characters at most), agents.prompt and created_at (the date you add the file, YYYY-MM-DD; it never changes later).
  • commission.mode is percentage, flat, tiered, hybrid or unknown, with value as the number (null when unknown). Give commission.currency; a flat amount cannot be read without it.
  • signup_url is the program page on the brand's domain, over https, not the homepage.
  • verified: false. Maintainers set it after checking.
  • Only terms the brand publishes. A term the page does not state is left out, never guessed.
  • restrictions is a list; duration is a bare length such as “12 months” or “lifetime”.

The automatic checks

A pull request from a fork that only adds files under programs/ is validated at once: schema, registry build and the markdown build. After a maintainer approves the workflow run, CI also crawls the signup URL. A red Vercel status on a fork is expected and is not a failure of your file.

Correct an existing program

The quickest way is a Terms changed issue with the slug and the URL of the page that states the new terms. A pull request that edits an existing file also works, but the fork check only accepts new files, so it shows as failed until a maintainer runs the full checks; edits are never merged automatically.