Thanks for your interest in contributing to OFMAPI. This document covers what we expect, how to set up a dev environment, and how to get a PR landed.
- One change per PR. Small, focused PRs land quickly; mega-PRs sit for weeks.
- Add or update tests for any code change. We aim for >=80% coverage on new code.
- Run the linter + formatter before pushing. CI will enforce; your local run saves a round trip.
- Use Conventional Commits for commit
messages:
feat:,fix:,docs:,chore:,refactor:,test:,perf:.
Per-repository instructions are in README.md. The general flow is:
- Fork the repo, create a feature branch off
main. - Make your change. Keep diffs surgical.
- Run the test suite locally.
- Open a PR against
mainwith a clear description and a "Closes #N" link if it resolves an issue.
By contributing you certify the Developer Certificate of Origin for
your contribution. Sign your commits with git commit -s.
- Open a Discussion on the repo
- Email hello@ofmapi.com for design questions