Het `project.yml` template

Elke repo krijgt een .github/project.yml. Dit bestand bevat alles wat we niet uit GitHub kunnen aflezen: doel, team-rollen, productieomgeving, en hoe collega's kunnen aanhaken. Kopieer onderstaande inhoud en pas aan.

Snel toevoegen aan je repo

Maak in je repo de map .github/ als die nog niet bestaat.
Plaats er een bestand project.yml met onderstaande inhoud.
Vul de velden in. Niet alles hoeft direct compleet te zijn — vul aan naarmate het project vordert.
Commit en push. De website pikt het automatisch op binnen één cache-cyclus.

.github/project.yml YAML

# .github/project.yml
#
# Plaats dit bestand in elke repo onder `.github/project.yml`.
# De projectensite leest het bij elke pagina-load en combineert het met live
# GitHub-data (commits, contributors, issues).
#
# Alle velden zijn optioneel maar samen vertellen ze het verhaal: wat bouw je,
# wie werkt eraan, waar draait het, en hoe kan iemand aanhaken.

# Korte, leesbare naam (mag afwijken van de repo-naam).
name: "Mijn Project"

# Eén krachtige zin: wat doet dit en voor wie?
tagline: "Korte one-liner die direct duidelijk maakt wat dit project oplost."

# Een van: idea | in-development | beta | production | maintenance | archived
status: in-development

# Wat is het doel? Waarom bestaat dit project? Wat is de waarde voor de organisatie?
# Mag meerdere regels — vertel het verhaal.
goal: |
  Beschrijf in 2-4 zinnen het probleem dat dit project oplost en voor wie.
  Wat is de impact als het werkt? Welke gebruikers/teams hebben er baat bij?
  Wat onderscheidt dit project van bestaande oplossingen?

# Wie werken er actief mee. Voeg jezelf toe, ook als je solo werkt.
team:
  - name: "Voornaam Achternaam"
    role: "Tech Lead"
    github: "github-username"
    email: "naam@bedrijf.nl"
  - name: "Collega Twee"
    role: "Product Owner"
    github: "andere-username"

# Waar draait (of komt) de productieomgeving?
production:
  url: "https://mijn-project.bedrijf.nl"
  environment: "AWS ECS / Azure App Service / on-premise / ..."
  status: "live"   # live | staging | not-deployed

# Technologie-stack — gebruikt voor filters en chips op de overzichtspagina.
stack:
  - "Astro"
  - "TypeScript"
  - "PostgreSQL"
  - "Docker"

# Vrije links — verschijnen in de zijbalk op de detailpagina.
links:
  demo: "https://demo.mijn-project.bedrijf.nl"
  docs: "https://confluence.bedrijf.nl/projecten/mijn-project"
  board: "https://github.com/orgs/.../projects/1"
  slack: "https://bedrijf.slack.com/archives/C0123456"

# Hoe kunnen collega's aanhaken? Dit blok krijgt extra prominentie in de UI.
contributing:
  looking_for:
    - "Frontend developer met React/Astro ervaring"
    - "UX designer voor de onboarding-flow"
    - "Iemand met affiniteit voor data-modellering"
  how_to_join: |
    Stuur Alex een DM op Slack of pak een issue met label `good first issue`.
    We hebben elke dinsdag om 10:00 een refinement, schuif gerust aan.
  good_first_issues: true

Velden in een oogopslag

name: Leesbare naam. Mag afwijken van de repo-naam.
tagline: Eén zin: wat doet dit en voor wie?
status: idea · in-development · beta · production · maintenance · archived
goal: Het verhaal: probleem, impact, doelgroep.
team: Wie werken er actief mee, met rol en GitHub-handle.
production: URL, omgeving (AWS/Azure/…) en deploy-status.
stack: Korte lijst van technologieën — verschijnt als chips.
links: Demo, docs, board, Slack — vrij in te vullen.
contributing: Wie zoek je? Hoe kan iemand aanhaken? Dit blok krijgt extra prominentie op de detailpagina — gebruik het om collega's enthousiast te maken.

Het project.yml template

Snel toevoegen aan je repo

Velden in een oogopslag

Het `project.yml` template