Synvael/synvael
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs(workspace): add branching strategy and CI guidelines

Browse source
This commit is contained in:
Serkyo 2026-05-12 11:47:04 +02:00
parent fd5d5e4e4b
commit 3a6e51d017
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
AGENTS.md
View file

@ -175,6 +175,12 @@ Things to be aware of when writing rendering or import code (these are *not* con
- **Blender is Z-up, right-handed.** Models exported from Blender need a coordinate swap on import (rotate −90° around X, or swap Y/Z with sign). Decide once where that swap happens — at export, at import, or never (by adopting Blender's convention) — and stick to it. Doing it in two places will eventually produce a model that's mirrored or upside-down and you'll spend an afternoon on it. - **Blender is Z-up, right-handed.** Models exported from Blender need a coordinate swap on import (rotate −90° around X, or swap Y/Z with sign). Decide once where that swap happens — at export, at import, or never (by adopting Blender's convention) — and stick to it. Doing it in two places will eventually produce a model that's mirrored or upside-down and you'll spend an afternoon on it.
- **glTF is Y-up, right-handed** — matches your engine convention, so it's the most friction-free model format if you have a choice. - **glTF is Y-up, right-handed** — matches your engine convention, so it's the most friction-free model format if you have a choice.
## Branching Strategy & Workflow
- **`main` vs `dev`**: The repository follows a strict workflow. The `main` branch is reserved purely for stable releases. All active development happens on the **`dev`** branch.
- **Feature Branches**: For any large feature, always create a new branch off of `dev` (e.g., `feat/new-worldgen`). Do not commit large, work-in-progress features directly to `dev`. Once the feature is complete and verified, merge it back into `dev`.
- **Continuous Integration**: The project enforces strict linting and formatting via GitHub Actions. This includes workspace-level `clippy` rules (banning `unwrap` and `println!`), `cargo fmt`, `selene` for Lua, and `stylua`. Always ensure your code passes these tools locally before pushing.
## Commit conventions ## Commit conventions
[**Conventional Commits**](https://www.conventionalcommits.org/) with **mandatory crate-name scope**. [**Conventional Commits**](https://www.conventionalcommits.org/) with **mandatory crate-name scope**.

6
CLAUDE.md
View file

@ -175,6 +175,12 @@ Things to be aware of when writing rendering or import code (these are *not* con
- **Blender is Z-up, right-handed.** Models exported from Blender need a coordinate swap on import (rotate −90° around X, or swap Y/Z with sign). Decide once where that swap happens — at export, at import, or never (by adopting Blender's convention) — and stick to it. Doing it in two places will eventually produce a model that's mirrored or upside-down and you'll spend an afternoon on it. - **Blender is Z-up, right-handed.** Models exported from Blender need a coordinate swap on import (rotate −90° around X, or swap Y/Z with sign). Decide once where that swap happens — at export, at import, or never (by adopting Blender's convention) — and stick to it. Doing it in two places will eventually produce a model that's mirrored or upside-down and you'll spend an afternoon on it.
- **glTF is Y-up, right-handed** — matches your engine convention, so it's the most friction-free model format if you have a choice. - **glTF is Y-up, right-handed** — matches your engine convention, so it's the most friction-free model format if you have a choice.
## Branching Strategy & Workflow
- **`main` vs `dev`**: The repository follows a strict workflow. The `main` branch is reserved purely for stable releases. All active development happens on the **`dev`** branch.
- **Feature Branches**: For any large feature, always create a new branch off of `dev` (e.g., `feat/new-worldgen`). Do not commit large, work-in-progress features directly to `dev`. Once the feature is complete and verified, merge it back into `dev`.
- **Continuous Integration**: The project enforces strict linting and formatting via GitHub Actions. This includes workspace-level `clippy` rules (banning `unwrap` and `println!`), `cargo fmt`, `selene` for Lua, and `stylua`. Always ensure your code passes these tools locally before pushing.
## Commit conventions ## Commit conventions
[**Conventional Commits**](https://www.conventionalcommits.org/) with **mandatory crate-name scope**. [**Conventional Commits**](https://www.conventionalcommits.org/) with **mandatory crate-name scope**.