First off, thank you for considering contributing to Zerm! It's people like you that make Zerm such a great tool.
As of now, this project is not accepting pull requests. While Zerm is open source and you're welcome to fork and modify it for your own use.
You can still contribute by:
- 🐛 Reporting bugs - Open an issue with detailed information
- 💡 Suggesting features - Share your ideas via issues or discussions
- 🍴 Forking the project - Feel free to create your own version
- 📖 Improving documentation - Suggest clarifications or corrections via issues
Thank you for understanding!
By participating in this project, you agree to abide by our Code of Conduct.
- Before submitting a bug report, please check if the issue has already been reported
- Use the bug report template when creating an issue
- Include as much relevant information as possible
- Include steps to reproduce the issue
- Open an issue using the feature request template
- Clearly describe the feature and its benefits
- Discuss potential implementation approaches
- Consider the feature's impact on existing functionality
-
Ensure you have all the requirements installed:
- macOS 14.4 or later
- Latest version of Xcode
- Latest version of Swift
- whisper.cpp properly set up
-
Follow our coding standards:
- Use Swift style guidelines
- Write meaningful commit messages
- Include comments where necessary
- Add tests for new features
-
Testing:
- Run existing tests
- Add new tests for new functionality
- Ensure all tests pass before submitting PR
- Follow Swift style guidelines
- Use meaningful variable and function names
- Keep functions focused and concise
- Comment complex logic
- Write self-documenting code where possible
- Join our discussions
- Help other contributors
- Share your ideas
- Be respectful and constructive
If you have any questions or need clarification, feel free to:
- Open an issue
- Start a discussion
- Reach out to the maintainers
Thank you for contributing to Zerm! 🎉