Skip to content

Commit 2a3da8a

Browse files
committed
Make contributing notes maintainer-focused
1 parent f038e81 commit 2a3da8a

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing
1+
# Development Notes
22

3-
Thanks for helping improve `ofmx2pgsql`. This repository is maintained by SkyAlgorithm and aims to stay small, auditable, and reliable.
3+
Notes for maintainers working on `ofmx2pgsql`. The goal is to keep the codebase small, auditable, and reliable.
44

55
## Quick Start
66
- Install locally: `pip install -e .`
@@ -14,11 +14,11 @@ Thanks for helping improve `ofmx2pgsql`. This repository is maintained by SkyAlg
1414
- Keep type hints where they improve clarity.
1515
- Avoid adding large data files to the repo (use `scripts/fetch_ofmx.sh`).
1616

17-
## Pull Requests
18-
Please include:
17+
## Changes
18+
When making changes, include:
1919
- A short summary of what changed and why.
2020
- Any new commands or flags (with examples).
2121
- Tests or validation steps run locally.
2222

2323
## Scope
24-
Focus changes on OFMX parsing, schema evolution, and import reliability. If you are proposing major new features, open an issue first.
24+
Focus changes on OFMX parsing, schema evolution, and import reliability. For major new features, align with SkyAlgorithm maintainers first.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ The LK sample data is fetched on demand into `data/ofmx_lk/` via `scripts/fetch_
6565

6666
Airspace records in the LK sample reuse `AseUid/@mid`, so `ofmx.airspaces.ofmx_id` is not unique. The schema uses a composite uniqueness constraint on `(ofmx_id, region, code_id, code_type, name)` to preserve distinct entries while keeping imports idempotent.
6767

68-
## Contributing
69-
See `CONTRIBUTING.md` for workflow, style, and pull request expectations.
68+
## Development Notes
69+
See `CONTRIBUTING.md` for workflow and style notes used by maintainers.
7070

7171
## Security
7272
See `SECURITY.md` for reporting guidance.

0 commit comments

Comments
 (0)