Contribute

How to contribute to GENIE.AI — open an MR, follow the dev workflow, add a translation, triage a CVE.

Mission

The Contribute section is everything you need to land a change in GENIE.AI: where the code lives, how to run the test suite locally, how to open a merge request, and how to triage the next CVE. It is the steward handoff — read once at the start of your first contribution, then keep it open in a tab.

If you are…

  • Opening your first MR → How to open a MR — branch policy, MR template, CI gates.
  • Setting up a dev environment → Dev workflow — env, lint, test, debug.
  • Finding where to put a new file → Repo layout — the full module map.
  • Adding a doc to this site → Add a new doc — Docsy frontmatter, mode badge, weight.
  • Cutting a release → Release process — tag, changelog, publish.
  • Adding a translation → i18n contribution — key parity rules.
  • Triaging a CVE finding → Security triage — triple-source verification playbook.
  • Writing prose that follows house style → Style guide — language policy, voice, code-block rules.

Pages in this section

  • Deploy — when your MR changes an env var or a Docker compose profile.
  • Operate — when your MR changes an operational procedure.
  • Reference — the canonical tables your docs must match.
How to open a MR

The full contribution checklist — branch policy, MR template, CI gates, and merge rules.

Repo layout & module map

Where each module lives — components, overlay, deploy, tests, docs, site.

Dev workflow

Set up a local dev environment — install, lint, test, debug, and iterate.

Add a new doc to this site

Docsy frontmatter, Diataxis mode, weights, related links, and the cross-link audit.

Build and run locally

Setting up a local development environment across all GENIE.AI components: prerequisites, commands, tests, linting, and observability.

Release process

Tag, changelog, publish — the MAJOR / MINOR / PATCH / pre-release flow.

i18n contribution

Add a translation — locale whitelists, key parity rules, and the no-duplicate-keys invariant.

Security triage (CVE playbook)

Triple-source verification, classification buckets, dismissal reasons, and the monthly loop.

Style guide

Language policy, voice, code blocks, headings, and the doc-audit checklist.

Last modified September 30, 2026: fix(docs): lean fix Commit 1 — IA weight reorder + about.md link fix (72c35f1ed)