Skip to content

docs: add CONTRIBUTING.md with setup guide and architecture overview #15

@LarytheLord

Description

@LarytheLord

Context

Open Permit is now accepting community contributions. New contributors need a clear guide to get started.

Task

Create `CONTRIBUTING.md` covering:

  1. Local dev setup — clone, install deps, env vars, run backend + frontend
  2. Architecture overview — what each major file does (server.js, personaConfig.js, permitIngestion.js, etc.)
  3. How to add a new persona — just add an entry to personaConfig.js
  4. How to add a new permit source — add to permit-sources.json + optional transformer
  5. How to add a new legal framework — add to getCountryLegalFramework()
  6. PR guidelines — branch naming, commit messages, testing
  7. Issue labels — what each label means

Reference

  • README.md has some info but is outdated
  • Backend structure is in `backend/`
  • Frontend is Next.js in `frontend/`

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions