Skip to content

Commit 250a5e7

Browse files
committed
Improve GitHub presentation and CI
1 parent acb536f commit 250a5e7

5 files changed

Lines changed: 287 additions & 103 deletions

File tree

.github/workflows/build.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
ubuntu-build:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
15+
- name: Install dependencies
16+
run: |
17+
sudo apt-get update
18+
sudo apt-get install -y build-essential cmake qtbase5-dev libqt5svg5-dev
19+
20+
- name: Configure
21+
run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
22+
23+
- name: Build
24+
run: cmake --build build

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Ferhan B
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)