Skip to content

Canonicalisation bundle: LICENSE, CI, contributor scaffolding, README rewrite#2

Merged
estebanzimanyi merged 1 commit intomasterfrom
canonicalisation-bundle
May 1, 2026
Merged

Canonicalisation bundle: LICENSE, CI, contributor scaffolding, README rewrite#2
estebanzimanyi merged 1 commit intomasterfrom
canonicalisation-bundle

Conversation

@estebanzimanyi
Copy link
Copy Markdown
Member

@estebanzimanyi estebanzimanyi commented May 1, 2026

Summary

This PR adds artefacts that ecosystem-grade org repos in MobilityDB carry but that the repo was previously missing. They land as one coordinated bundle on top of the lineage-credit work in PR #1.

File Why
LICENSE.txt The PostgreSQL License, matching the MobilityDB main project. Without this the repo is effectively all-rights-reserved by default — biggest concrete gap. Copyright assigned to ULB and MobilityAPI contributors.
.github/workflows/python.yml CI stub: ruff lint (warning-only at this stage) + import-smoke-test on every PR. No DB-integration yet; that's a separate effort once the test harness stabilises.
CONTRIBUTING.md Dev setup, test instructions, code style, PR conventions. Cross-references AUTHORS.md and the README lineage section.
.github/ISSUE_TEMPLATE/bug.md + feature.md Issue triage scaffolding. Bug asks for environment info; feature prompts for OGC-spec references.
.github/PULL_REQUEST_TEMPLATE.md PR shape — what changed, related issues, testing, checklist.
README.md (rewritten) Canonical-home framing — see below.

README rewrite — what changed

  • Badges added: License, Python version, OGC API conformance.
  • Lead changed from generic introduction to a positioning statement: "MobilityAPI is the HTTP / OGC layer of the MEOS ecosystem".
  • Status section added, pointing at the GitHub issues and discussions tabs.
  • "Where MobilityAPI fits" section added: shows MEOS as canonical C library, MobilityDB and MobilityDuck as peer SQL layers, and the language bindings around them.
  • Cross-link to https://libmeos.org/bindings/mobilityapi/.
  • Contributing section added, pointing at CONTRIBUTING.md.
  • Typos fixed ("Pyhton" → "Python", "Developement" → "Development", removed orphaned ##Poetry section).
  • License section points at LICENSE.txt and CITATION.cff explicitly.
  • Lineage section preserved verbatim.

Out of scope (deliberately)

  • DB-integration CI — needs a Postgres + MobilityDB service container, can be flaky, and the existing test harness needs tuning before it runs in CI. Separate PR when ready.
  • Type checking (mypy / pyright) — useful but the codebase isn't typed yet. Adding the gate before adopting types would block all PRs.
  • Coverage reporting — same — needs typed infrastructure first.

These are sensible follow-ups but not part of the canonicalisation work itself.

Checklist

Cc

  • @sirimeraoui — current maintainer; courtesy review on the README structure and CONTRIBUTING choices.

🤖 Generated with Claude Code

…ADME rewrite

The repo is now the canonical home of MobilityAPI but was missing
several artefacts that ecosystem-grade org repos carry:

1. **LICENSE.txt** — The PostgreSQL License, matching the
   MobilityDB main project's licence posture. Without this,
   the repository was effectively all-rights-reserved by
   default. Copyright Université libre de Bruxelles and
   MobilityAPI contributors.

2. **CONTRIBUTING.md** — Development setup, test instructions
   (./run.sh, ./run.sh --with-tests), code-style conventions
   (PEP 8 + ruff), PR conventions. Cross-references AUTHORS.md
   and the lineage section in the README.

3. **.github/workflows/python.yml** — Stub CI:
   - Lint job: ruff check on PRs (warning-only at this stage so
     legacy code isn't blocked; tighten when codebase has been
     once-through).
   - Import-smoke-test job: imports each application module so
     a minimal "code is at least loadable" gate runs on PRs.
   No DB-integration tests at this stage; that's a separate
   GitHub Actions service-container effort once the test
   harness stabilises.

4. **.github/ISSUE_TEMPLATE/{bug,feature}.md** + **PULL_REQUEST_TEMPLATE.md**
   — issue / PR scaffolding. Bug template asks for environment
   info; feature template prompts for OGC-spec references.

5. **README rewrite** — restructured for canonical-home framing:
   - Added badges (License, Python, OGC API conformance).
   - Lead with what MobilityAPI is (HTTP / OGC layer of the MEOS
     ecosystem) rather than the bare introduction.
   - Added a Status section pointing at issues + discussions.
   - Added a "Where MobilityAPI fits" section showing peer SQL
     layers (MobilityDB / MobilityDuck) and language bindings.
   - Cross-link to https://libmeos.org/bindings/mobilityapi/.
   - Added Contributing section pointing at CONTRIBUTING.md.
   - Fixed "Pyhton" / "Developement" typos and the orphaned
     ##Poetry section. Final License section points at LICENSE.txt
     and CITATION.cff.
   - Lineage section (PR #1) preserved unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@estebanzimanyi estebanzimanyi merged commit 726470b into master May 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant