Contributing
How to contribute to RefleK's.
Open Source
RefleK's is fully open source under the GPL v3 license. We welcome contributions from the community!
Getting Started
- Fork the GitHub repository
- Clone your fork locally
- Set up the development environment (see README)
- Make your changes
- Submit a pull request
Development Stack
RefleK's is built with:
- Backend: Go with Wails framework
- Frontend: React, TypeScript, Tailwind CSS
- Build: Vite
Ways to Contribute
You can contribute in many ways:
- Code: Fix bugs, add features, improve performance
- Documentation: Improve guides, fix typos, add examples
- Testing: Report bugs, test new features
- Ideas: Suggest improvements and new features
- Community: Help others in Discord, answer questions
Beta Testing
Want to try new features before they're released? Join our Discord server to get access to dev builds:
- Early access: Test new features while they're still in development
- Direct feedback: Share your thoughts directly with the developers
- Shape the app: Your feedback helps decide what gets improved or changed
Dev builds are posted in the beta testing channels on Discord. These builds may have bugs or incomplete features, but you'll be the first to try new functionality.
Code Guidelines
When contributing code:
- Follow the existing code style
- Write clear commit messages
- Make sure it builds and runs without errors on Windows
- Update documentation if needed
Pull Request Process
- Create a feature branch from
main - Make your changes with clear commits
- Test that the app builds and runs on Windows
- Push to your fork
- Open a pull request with a clear description
- Respond to any feedback from reviewers
Questions? Join our Discord server
and ask in the development channels.