Files
Incido/CONTRIBUTING.md
T
Incido Developer f87ca17ded
dev / Build debug APK (push) Successful in 57s
release / Build & attach release APK (push) Successful in 1m31s
feat: v0.4.2.0 — voice notes (Opus 32 kbps mono), toolbar reorder, backup-first release notes
Voice notes: record in-note via framework MediaRecorder; takes stored as compact Opus-in-Ogg (.opus, 32 kbps, single channel, 48 kHz) on API 29+ with AAC/.m4a fallback on API 26-28; MediaPlayer bar with Download to system Downloads. Editor toolbar reordered Photo / Voice / Attach / Tasks / Shopping list, hashtag justified flush right. Release notes across README / PREVIOUS_HISTORY / ReleaseNotes / CONTRIBUTING / Development Plan now open every release with a back-up-before-installing warning (standing convention). versionCode 38, versionName 0.4.2.0, APP_VERSION lockstep; assembleDebug + assembleRelease green.
2026-09-23 16:56:57 +12:00

6.2 KiB
Raw Permalink Blame History

Contributing to Incido

First off, thank you for taking the time to contribute! 🎉 Incido is a small, privacy-focused project and every contribution — bug reports, documentation fixes, code, translations — makes a real difference.

How can I contribute?

There are several ways you can help:

🐛 Reporting bugs

Open a bug report on the issue tracker. Include:

  • Device model and Android version
  • App version (Settings → Apps → Incido → App info or adb shell dumpsys package org.incido.app)
  • Steps to reproduce
  • Expected vs actual behaviour
  • Screenshots or screen recordings if relevant

💡 Suggesting features

Open a feature request. Before you do, check the existing issues and the Development Plan §6 backlog — the feature you want may already be on the roadmap.

🌍 Translating

Incido is currently English-only. Once we add translation infrastructure (Weblate or Crowdin, per §6.8), every locale helps.

🔧 Submitting code changes

Open a pull request. See the workflow below.


Development workflow

1. Pick something to work on

  • Check existing issues for good first issue or help wanted labels.
  • Or grab an item from §6 of the Development Plan that's not yet implemented.

2. Branch

  • Branch off main.
  • Use a descriptive name:
    • feat/favorites-stars
    • fix/editor-ime-on-android-12
    • refactor/extract-color-picker

3. Make your changes

  • Follow the existing code style (Kotlin official style; Compose conventions as already used in the codebase).
  • Add unit tests for non-trivial logic in core/domain or core/data (UI changes don't require new tests in v0.2).
  • Update the Development Plan §10 history table if your change is user-visible.

4. Verify locally

./gradlew assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk

…then run through the relevant smoke test from the Development Plan §7.2 or your feature's manual verification steps.

5. Commit

We use Conventional Commits. Per-version user-facing notes live in PREVIOUS_HISTORY.md (Development Plan §11.1) — the release CI attaches the matching section to each Gitea release automatically. Write each note (paragraph or bullet) as one complete line — do not hard-wrap it: the CI copies the section verbatim, so manual line breaks ship as premature returns, and the release UI reflows the text for you. From v0.4.2.0 on, every new release section must open with the standard backup-warning callout — ask users to make certain they have a current backup (Settings → Backup & Restore → Export, plus the encryption-key export under Settings → Security) before installing the new version. This reminder ships with every release.

Commit types:

Type Use for
feat: new user-visible feature
fix: bug fix
chore: maintenance (deps, tooling, no user impact)
docs: documentation only
refactor: code change that neither fixes a bug nor adds a feature
test: adding or fixing tests

Example:

feat(notes): add color-coded notes

Adds 6 preset accent colours (NONE / BLUE / GREEN / AMBER / RED / PURPLE)
backed by a NoteColor enum. Users pick from a swatch row in the editor;
a 4dp vertical stripe renders on the left of each list card.

Closes #42

6. Open a Pull Request

  • Push your branch and open a PR against main.
  • Fill out the PR template.
  • A Gitea Actions build will run automatically — make sure it passes.
  • A maintainer will review; expect 1–2 rounds of feedback on your first PR.

GPL-3.0 contribution terms

Incido is licensed under the GNU General Public License v3.0. By submitting a contribution, you affirm:

  1. The contribution is your own original work, or you have the right to submit it under the GPL-3.0.
  2. You agree your contribution is licensed under GPL-3.0 (or a compatible licence) and that the project may redistribute it under those terms.

If you're contributing on behalf of an employer or as part of work-for-hire, please confirm you have authority to license the work under GPL-3.0 before opening the PR.


Code style

  • Kotlin: Kotlin coding conventions.
  • Compose: Prefer stateless composables, hoist state, use Modifier parameter ordering Modifier.size().background().clickable().
  • Imports: Wildcard imports are discouraged. Group: Android → Compose → third-party → internal.
  • Naming: PascalCase for types, camelCase for functions/properties, UPPER_SNAKE_CASE for constants.
  • Strings: Hard-coded UI strings in the UI layer are fine for v0.2; once translation infrastructure lands, all user-visible strings must move to strings.xml.

Commit message rules

  • 72-character subject line (no period at end)
  • Imperative mood ("add", not "added" / "adds")
  • Blank line, then body wrapped at 72 chars
  • Body explains what and why, not how

Release process (for maintainers)

Version scheme (from v0.3.0.0 onwards): MAJOR.MINOR.MAINTENANCE.EMERGENCY — e.g. 0.3.0.0. MAJOR.MINOR.MAINTENANCE are normal release numbers; EMERGENCY is non-zero only for hotfixes shipped out-of-band. versionCode is a monotonic int and always +1 per release. A build with a versionName that doesn't match ^\d+\.\d+\.\d+\.\d+$ fails immediately — there's a validator in app/build.gradle.kts.

  1. Bump versionCode (+1) and versionName in app/build.gradle.kts.
  2. Update the Development Plan §10 history table with the new dot-name, and give the release its PREVIOUS_HISTORY.md section — opening, as every release does from v0.4.2.0 on, with the standard backup-warning callout (users must back up before installing).
  3. Tag the commit: git tag -s vX.Y.Z.W -m "vX.Y.Z.W — short summary".
  4. ./gradlew assembleDebug assembleRelease — confirm both green.
  5. Upload app/build/outputs/apk/release/app-release.apk to Gitea Releases.
  6. Push the tag: git push origin vX.Y.Z.W.

Thanks again for contributing! 🙏