Getting Started¶
Set up a workflow to contribute firmware changes and submit Merge Requests to the kurikintons project.
Prerequisites¶
Complete the Developer Guide setup before contributing.
Workflow Overview¶
- Create a worktree from
mainor a feature branch - Build and verify the firmware
- Commit with conventional commit format
- Push and open a Merge Request on GitLab
See Build & Upload for the full step-by-step workflow.
Check Available Versions¶
List all released versions:
git tag --list | sort -V
To work on a specific version, create a worktree from its tag:
git worktree add ../kurikintons-v2.6.0 2.6.0
cd ../kurikintons-v2.6.0
Next Steps¶
- See Build & Upload to start contributing
- See Clang Format for code style and formatting
- See Pre-commit Hooks for code quality checks
- See Architecture Overview to understand the codebase
- See API Reference for the v2 protocol