|
| 1 | +# CONTRIBUTING.md |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +Thank you for contributing! |
| 6 | +This project is maintained with a focus on consistency across multiple related repositories. |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## Branch Strategy |
| 11 | + |
| 12 | +* `main` and `develop` branches are managed directly by maintainers |
| 13 | +* Contributors should NOT push directly to `main` or `develop` |
| 14 | +* All changes must be submitted via Pull Request |
| 15 | + |
| 16 | +### Release |
| 17 | + |
| 18 | +* Releases are managed via Git tags |
| 19 | +* No separate release branches are used |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +## Pull Request Guidelines |
| 24 | + |
| 25 | +* All changes must go through Pull Request |
| 26 | +* Keep PRs small and focused (one logical change per PR) |
| 27 | +* Avoid mixing unrelated changes |
| 28 | + |
| 29 | +### PR Description must include: |
| 30 | + |
| 31 | +* What was changed |
| 32 | +* Why it was changed |
| 33 | +* How it was tested (or verified) |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## Commit Message Convention |
| 38 | + |
| 39 | +Use the following prefixes: |
| 40 | + |
| 41 | +* `feat` - for new features or enhancements |
| 42 | +* `fix` - for bug fixes |
| 43 | +* `chore` - for maintenance tasks (e.g., updating dependencies, formatting) |
| 44 | +* `test` - for adding or updating tests |
| 45 | +* `build` - for build-related changes (e.g., CI configuration) |
| 46 | +* `refactor` - for code restructuring without changing functionality |
| 47 | + |
| 48 | +### Rules |
| 49 | + |
| 50 | +* Messages must be written in **sentence form** |
| 51 | +* `feat` messages must start with an **imperative verb** |
| 52 | + |
| 53 | +### Examples |
| 54 | + |
| 55 | +``` |
| 56 | +feat: Add terrain sampling option |
| 57 | +fix: Resolve bounding box overflow issue |
| 58 | +refactor: Simplify voxel processing logic |
| 59 | +chore: Update dependency versions |
| 60 | +``` |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## Common Module Policy (mago-common) |
| 65 | + |
| 66 | +`mago-common` is a shared module used across multiple projects such as: |
| 67 | + |
| 68 | +* mago-3d-tiler |
| 69 | +* mago-3d-terrainer |
| 70 | + |
| 71 | +### Rules |
| 72 | + |
| 73 | +* Only implement **general-purpose and reusable logic** |
| 74 | +* Avoid project-specific code inside `mago-common` |
| 75 | +* Keep the structure simple and broadly applicable |
| 76 | + |
| 77 | +### IMPORTANT |
| 78 | + |
| 79 | +* All modifications must be **carefully reviewed before merging** |
| 80 | +* Changes in common logic may affect multiple projects |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +## Subtree Sync Policy |
| 85 | + |
| 86 | +This repository uses `git subtree` for synchronization. |
| 87 | + |
| 88 | +### Rules |
| 89 | + |
| 90 | +* Do NOT run `git subtree push` |
| 91 | +* Use `git subtree pull` only when syncing |
| 92 | +* Shared logic must be updated at the source before syncing |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +## Review Criteria |
| 97 | + |
| 98 | +Pull Requests will be reviewed based on: |
| 99 | + |
| 100 | +* Reusability (no project-specific logic in common modules) |
| 101 | +* Code clarity and simplicity |
| 102 | +* Avoidance of duplicated logic |
| 103 | +* Minimal and focused changes |
| 104 | + |
| 105 | +--- |
| 106 | + |
| 107 | +## Testing |
| 108 | + |
| 109 | +* Add tests when applicable |
| 110 | +* If tests are not included, clearly describe how the change was verified |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +## Notes |
| 115 | + |
| 116 | +If your change affects shared logic or has wide impact, |
| 117 | +please discuss it before implementation. |
| 118 | + |
| 119 | +When unsure, open an issue first. |
0 commit comments