Thanks for your interest in contributing! Here's how to get started.
- Fork the repo and clone your fork
- Make sure you have Xcode 15+ and Swift 6.0 installed
- Run
swift buildto verify everything compiles - Run
swift runto launch the app in debug mode
- Create a branch off
mainfor your work - Keep commits focused — one logical change per commit
- Test your changes by building and running the app locally
- Make sure
swift buildcompiles without warnings
- Open a PR against
main - Describe what you changed and why
- Keep PRs small and focused — easier to review, faster to merge
- If your PR adds a new feature, mention how to test it
- Sparkle is used for in-app updates
- Keep
SUPublicEDKeyandSUFeedURLinSources/Peeler/Resources/Info.plistaligned with the release pipeline
- Follow existing patterns in the codebase
- Use SwiftUI for UI, AppKit only where necessary
- Keep files focused on a single responsibility
- Keep third-party dependencies minimal and justified
- Use GitHub Issues to report bugs or suggest features
- Include your macOS version and steps to reproduce for bugs
- Screenshots are helpful for UI issues
By contributing, you agree that your contributions will be licensed under the MIT License.