|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Scope |
| 4 | + |
| 5 | +This repository is currently a research and prototyping codebase for marine route planning. Contributions that improve reproducibility, build reliability, algorithm clarity, and dataset handling are the most useful. |
| 6 | + |
| 7 | +## Development Setup |
| 8 | + |
| 9 | +On Ubuntu: |
| 10 | + |
| 11 | +```bash |
| 12 | +sudo apt-get update |
| 13 | +sudo apt-get install -y build-essential cmake qtbase5-dev libqt5svg5-dev |
| 14 | +cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug |
| 15 | +cmake --build build -j |
| 16 | +``` |
| 17 | + |
| 18 | +Optional data preparation: |
| 19 | + |
| 20 | +```bash |
| 21 | +./scripts/download_coastline_data.sh |
| 22 | +``` |
| 23 | + |
| 24 | +## Contribution Guidelines |
| 25 | + |
| 26 | +- Keep changes focused and easy to review. |
| 27 | +- Prefer small pull requests over large mixed changes. |
| 28 | +- Do not commit generated caches, local virtual environments, or large temporary datasets. |
| 29 | +- Update `README.md` when user-facing commands, data expectations, or outputs change. |
| 30 | +- Add or update validation steps when changing planner behavior. |
| 31 | + |
| 32 | +## Good Contribution Areas |
| 33 | + |
| 34 | +- CI and cross-platform build improvements |
| 35 | +- automated smoke tests |
| 36 | +- dataset packaging and size reduction |
| 37 | +- benchmark scenarios and reproducibility |
| 38 | +- route quality validation and regression checks |
| 39 | +- documentation, examples, and demo assets |
| 40 | + |
| 41 | +## Pull Requests |
| 42 | + |
| 43 | +When opening a pull request, include: |
| 44 | + |
| 45 | +- what changed, |
| 46 | +- why it changed, |
| 47 | +- how you validated it, |
| 48 | +- any dataset or environment assumptions. |
| 49 | + |
| 50 | +If your change affects outputs, include at least one screenshot, SVG, or command example. |
| 51 | + |
| 52 | +## Issues |
| 53 | + |
| 54 | +Please use issues for: |
| 55 | + |
| 56 | +- build failures, |
| 57 | +- incorrect routing behavior, |
| 58 | +- dataset import problems, |
| 59 | +- reproducibility gaps, |
| 60 | +- documentation problems. |
| 61 | + |
| 62 | +Clear reproduction steps are more useful than long descriptions. |
0 commit comments