Skip to content

Proposal: add a CONTRIBUTING.md #751

Description

@chrisdebian

Olauncher doesn't currently have a CONTRIBUTING.md, and the README's old "to maintain simplicity, a few niche features are hidden" guidance is the closest thing to a written scope statement. Since a couple of recent contributions (including mine) have had to guess at process, I thought it'd help to have something written down. Draft below, happy to adjust anything before opening a PR.

# Contributing to Olauncher

Olauncher aims to stay minimal — a distraction-free, ad-free launcher. Not every feature
request fits that goal; some niche features are kept hidden rather than exposed by default.

## Before opening a PR

- For anything beyond a small, obvious fix, please open an issue first describing what you'd
  like to do and why, so we can agree on scope before you invest time in code.
- Bigger feature ideas or scope questions are best raised as a GitHub Discussion (Ideas
  category) first.
- Keep PRs focused — one concern per PR.

## Building the project

- Android Studio, Kotlin, compileSdk 36 / minSdk 24 / targetSdk 36, JVM target 17.
- No CI currently runs on this repo, so please build and test locally before opening a PR:
  `./gradlew assembleDebug` and `./gradlew testDebugUnitTest`.

## Code style

- No ktlint/detekt config exists in this repo yet — match the style of the file you're editing.

## Licence

- GPLv3 — by contributing, you agree your changes are licensed under the same terms.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions