Kuro is open source and built with community contributions in mind. You can help by reporting bugs, suggesting ideas, improving the code or just sharing feedback.
Ways to contribute
- Report bugs on GitHub Issues (opens in a new tab). See Troubleshooting for what to include.
- Propose features. Feature requests and larger ideas go to a discussion before implementation.
- Contribute code through the repository (opens in a new tab).
- Join the community on Discord (opens in a new tab) to ask questions and give feedback.
Before you start
- Read the Code of Conduct (opens in a new tab).
- Read the repository's contribution guide (opens in a new tab).
- Talk through larger ideas before you write the code.
Branch structure
dev is the main branch and the repository's default branch. stable is the release branch. Urgent fixes, such as security patches, can go directly to stable. The contribution guide (opens in a new tab) has the full branch diagram.
Set up a development environment
git clone https://github.com/Kuro-Browser/Kuro-Desktop.gitBefore setting up a development environment, read the building guidelines (opens in a new tab) that the contribution guide points to. Skipping them can lead to avoidable build errors.
Architecture expectations
Kuro is organized into independent systems, so a feature can evolve without affecting unrelated parts. When you contribute:
- Keep Kuro-specific code separate from upstream code wherever practical, and make it clear which code is upstream, which is a Kuro modification, which is Kuro-exclusive and which is platform-specific.
- Keep systems modular. Avoid putting large amounts of unrelated logic in a single file.
- Avoid unnecessary platform-specific code, so macOS and Linux can follow Windows without major restructuring.
- Prefer quality over quantity. Every system should prioritize reliability, security, privacy and performance, followed by maintainability, modularity, accessibility and user control.
Pull requests, code style and testing
License
Kuro is distributed under the Mozilla Public License 2.0 unless otherwise specified. See the LICENSE (opens in a new tab) file.