AReaL commit message conventions. MUST load on every git commit -- provides Conventional Commits format with scope inference from file paths.
Commit message conventions and scope inference rules for the AReaL repository.
ALWAYS load this skill when making any git commit in AReaL. This includes:
git commit)/create-pr)skills: ["commit-conventions"]<type>(<scope>): <subject>
<body>
[Optional sections:]
Key changes:
- change 1
- change 2
Refs: #123, #456
| Type | When to Use |
|---|---|
feat | New feature or capability |
fix | Bug fix |
docs | Documentation only |
refactor | Code change without feature/fix |
test | Adding or fixing tests |
chore | Build, deps, config changes |
perf | Performance improvement |
Infer scope from the primary changed file paths:
| File Path Pattern | Scope |
|---|---|
areal/workflow/ | workflow |
areal/engine/ | engine |
areal/reward/ | reward |
areal/dataset/ | dataset |
areal/api/ | api |
areal/utils/ | utils |
areal/infra/ | infra |
areal/trainer/ | trainer |
areal/models/ | models |
areal/experimental/ | archon |
docs/ | docs |
examples/ | examples |
AGENTS.md, .agents/, .claude/, .codex/, .opencode/ | agents |
| Multiple areas | Omit scope or use broader term |
Single file fix:
fix(reward): handle empty completion in gsm8k
Return 0 reward instead of raising exception when
completion string is empty after extraction.
Multi-file feature:
feat(engine): add CPU offload support to ArchonEngine
Enable torch_memory_saver for model offloading during
rollout phase to reduce GPU memory pressure.
Key changes:
- Add offload/onload methods to ArchonEngine
- Integrate with weight update flow
- Handle ROCm compatibility
Docs only: