Skip to content

Commit dc12ced

Browse files
committed
Add public contributing and security docs
1 parent 6902016 commit dc12ced

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
Thanks for helping improve `ofmx2pgsql`. This repository is maintained by SkyAlgorithm and aims to stay small, auditable, and reliable.
4+
5+
## Quick Start
6+
- Install locally: `pip install -e .`
7+
- Fetch sample data: `scripts/fetch_ofmx.sh`
8+
- Run tests: `python -m unittest discover -s tests`
9+
- Run a dry import: `python -m ofmx2pgsql import --config config/ofmx2pgsql.example.ini --dry-run --verbose`
10+
11+
## Code Style
12+
- Use 4-space indentation and keep line lengths reasonable.
13+
- Prefer explicit names and small functions over compact logic.
14+
- Keep type hints where they improve clarity.
15+
- Avoid adding large data files to the repo (use `scripts/fetch_ofmx.sh`).
16+
17+
## Pull Requests
18+
Please include:
19+
- A short summary of what changed and why.
20+
- Any new commands or flags (with examples).
21+
- Tests or validation steps run locally.
22+
23+
## Scope
24+
Focus changes on OFMX parsing, schema evolution, and import reliability. If you are proposing major new features, open an issue first.

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# ofmx2pgsql
22

3+
[![CI](https://github.com/SkyAlgorithm/ofmx2pgsql/actions/workflows/ci.yml/badge.svg)](https://github.com/SkyAlgorithm/ofmx2pgsql/actions/workflows/ci.yml)
4+
5+
An open-source SkyAlgorithm project.
6+
37
Lightweight importer for OpenFlightMaps OFMX data into PostgreSQL/PostGIS. The goal is a small, auditable pipeline that parses OFMX XML, normalizes geometries, and loads core aviation features into a spatial schema.
48

59
## Status
6-
Importer and schema are functional for the LK sample dataset. See `TODO.md` for remaining work and `PROGRESS.md` for a running log of changes.
10+
Importer and schema are functional for the LK sample dataset. Data is fetched on demand and CI validates parser behavior and the Docker import path.
11+
12+
## Design Principles
13+
- Keep the pipeline small and auditable.
14+
- Favor explicit schemas over implicit inference.
15+
- Make data fetching and imports reproducible.
716

817
## Setup
918
- `pip install -e .` installs the package and the `psycopg` dependency.
@@ -16,6 +25,7 @@ Importer and schema are functional for the LK sample dataset. See `TODO.md` for
1625
- `sql/migrations/` PostGIS schema migrations.
1726
- `config/` example configuration files.
1827
- `tests/` minimal unit tests for parser and CLI.
28+
- `scripts/` helper scripts for fetching data and container workflows.
1929

2030
## Current Capabilities
2131
- Streaming XML parsing for OFMX datasets (Ahp, Rwy, Rdn, Ase, Dpn, Ndb/Vor/Dme).
@@ -55,6 +65,12 @@ The LK sample data is fetched on demand into `data/ofmx_lk/` via `scripts/fetch_
5565

5666
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.
5767

68+
## Contributing
69+
See `CONTRIBUTING.md` for workflow, style, and pull request expectations.
70+
71+
## Security
72+
See `SECURITY.md` for reporting guidance.
73+
5874
## Roadmap
5975
- Expand parser coverage for additional OFMX features (procedures, routes, obstacles).
6076
- Add integration tests that validate full imports against a disposable PostGIS instance.

SECURITY.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
We support the latest `main` branch. If you find an issue in an older commit, please still report it.
5+
6+
## Reporting a Vulnerability
7+
Please report security issues via GitHub Security Advisories:
8+
https://github.com/SkyAlgorithm/ofmx2pgsql/security/advisories/new
9+
10+
If you need to share sensitive details, include a minimal reproduction and the environment where the issue was observed.
11+
12+
We aim to acknowledge reports within 5 business days.

0 commit comments

Comments
 (0)