Thanks for helping make Oleafly better. This is the default contribution guide
for repositories under the Oleafly organization. A repository may have its own
CONTRIBUTING.md with extra detail, and that takes precedence.
- Report a bug or request a feature by opening an issue.
- Send a fix or improvement as a pull request.
- Add or fix a template in
Oleafly/template-packs. - Improve the docs and site in
Oleafly/oleafly-web.
- Fork the repository and branch from its default branch.
- Keep the change focused. Unrelated edits belong in separate pull requests.
- For code, run the checks the repository documents (typically lint, typecheck, build, and tests) and make sure they pass.
- Match the style of the surrounding code.
- Write a clear pull request description: what changed, why, and how you tested it.
The desktop app lives at Oleafly/Oleafly. See that repository's
CONTRIBUTING.md and docs/development.md for the full local setup, including
the frontend, the Rust backend, and the sidecar toolchain.
By participating you agree to uphold the project's CODE_OF_CONDUCT.md.