Skip to content

Contributing

mavrovde edited this page Nov 1, 2026 · 1 revision

Contributing

viafrei-api is in its design phase. The most valuable contributions right now are questions, reviews of the design and proposals for the endpoint plan.

How to follow progress

  • Watch the repository (Releases, or All activity) to be notified of new releases and discussions.
  • Issues track planned work, grouped by the phases on Roadmap.
  • Pull requests show every change with its checks and review.
  • Releases carry a generated changelog.
  • This wiki is updated when the design changes; Project Status always reflects the current state.
  • The ViaFrei website, viafrei.de, has news about the platform as a whole.

How to give feedback

You want to… Do this
Ask a question about the design Open an issue and describe your use case
Suggest an endpoint or a field Open an issue: who needs it, the question it answers, an example request and response
Report a documentation error Open an issue or a pull request against the documentation
Report a security problem Use private vulnerability reporting on the repository (Security tab). Please do not open a public issue for a vulnerability

Feature requests are judged by the domain question they answer, not by the data they expose. A request like "expose table X" will be reframed as "what question do you need answered?" (see Domain Model).

Code contributions

Once implementation starts:

  1. Open or pick an issue and say you are working on it.
  2. Fork, branch, and keep the change focused.
  3. Use a Conventional Commit title for the pull request.
  4. Include tests, documentation and examples in the same pull request.
  5. Make sure every required check is green.
  6. A code owner reviews; address the comments; the change is squash-merged.

Rules every contribution must follow

  • No live data-provider calls in tests. Use fixtures.
  • Nothing about how data is collected, and no platform-internal names, in code, documentation or the OpenAPI document. The scope lint enforces this.
  • Attribution on every data response.
  • No tunable literals. Every timeout, limit and size is a configuration key with a default, bounds and a test.
  • Public field names come from the domain, never from storage.
  • No request may run longer than 2 seconds.

What we cannot accept

  • Endpoints that let a caller filter or sort arbitrary storage columns.
  • Changes that weaken the licence gate, attribution or key handling.
  • Dependencies with licences incompatible with the project's licence, or unmaintained dependencies on critical paths.

Code of conduct

Be respectful, precise and constructive. Disagreement about design is welcome when it comes with reasons.

Home

About

Design

Data Model

Technical specification

Testing

Engineering

Technology choice

Reference

Clone this wiki locally