Contributing
We welcome contributions to rootfont. Here's how to get involved.
Ways to Contribute
- Report bugs — Open an issue with version info, steps to reproduce, and expected vs actual behavior
- Suggest features — Open a discussion in the Discussions tab
- Submit code — Fix bugs or implement features via pull request
- Improve docs — Help clarify or expand documentation
- Translate — Add or improve localizations
Development Setup
- Fork the repository on GitHub
- Clone your fork locally
- Ensure Xcode 15+ and Swift 6.0+ are installed
- Run
swift buildto verify the project compiles - Run
swift testto confirm tests pass - Install git hooks:
bash scripts/install-git-hooks.sh
Pull Request Guidelines
- Keep PRs focused — one feature or fix per PR
- Follow existing code style and conventions
- Add tests for new functionality
- Update localization strings if you add UI text
- Run
python3 scripts/check-l10n.pybefore submitting - Ensure CI passes (swift build, swift test, localization check, version check)
Reporting Bugs
When opening an issue, include:
- rootfont version and build (from About → Copy Version)
- About → Copy System Info output
swift --versionandxcode-select -p- Steps to reproduce
- Expected vs actual behavior
Code of Conduct
This project follows the Contributor Covenant. Please be respectful and inclusive in all interactions.