Skip to content

Commit 088f01d

Browse files
author
william ghysels
committed
Add contribution guardrails
Add CI syntax check, CODEOWNERS, and contribution guidelines to keep the repo clean.
1 parent 64a4e55 commit 088f01d

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
compile:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-python@v5
13+
with:
14+
python-version: "3.11"
15+
- name: Compile Python (syntax check)
16+
run: |
17+
python -m py_compile image_database.py visualize_umap.py

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @droon

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Contributing
2+
3+
Please open a pull request for any change.
4+
5+
### Rules
6+
7+
- Do not commit personal/local configuration (`config.json`) or any databases (`*.db`).
8+
- Keep all paths in docs/examples generic (`/path/to/...`).
9+
- Avoid committing generated files like `__pycache__/`.
10+
11+
### Checks
12+
13+
CI runs a lightweight syntax check (`python -m py_compile`) on `image_database.py` and `visualize_umap.py`.

0 commit comments

Comments
 (0)