Files
Incido/CONTRIBUTING.md
T
Incido Developer 5e1b77bedf feat: v0.2 - polish, favourites, search, colours, checklists, signing
v0.2 bundles all four phases from the planning session into a single
shippable release. versionCode 2 -> 3, versionName 0.1.1 -> 0.2.

DOMAIN
  - Add NoteColor enum (NONE / BLUE / GREEN / AMBER / RED / PURPLE).
  - Note: isFavorite + color fields; checklistCounts / checklistSummary
    helpers parsing '- [ ]' / '- [x]' lines.
  - NoteRepository: new search(query) + setFavorite(id, value) methods.

DATA
  - NoteEntity: additive @Index isFavorite + colorKey (Short).
  - NoteRepositoryImpl: search uses ObjectBox 'contains' case-insensitive;
    observeAll + search sort favourites-first then updatedAt DESC.

UI
  - NoteListViewModel: debounced(150ms) query -> repository.search;
    openSearch / closeSearch helpers; toggleFavorite.
  - NoteListScreen: search bar in top app bar; star icon + 4dp colour
    stripe per card; checklist summary line ('N open - M done').
  - NoteEditorViewModel: toggleFavorite + setColor; initial-snapshot
    fields captured on first non-null observeById for dirty detection.
  - NoteEditorScreen: BackHandler + AlertDialog 'Discard changes?' on
    unsaved edits; star toggle in top bar; LazyRow of colour swatches.

POLISH
  - Discard-confirm dialog implements Development Plan §5.2.
  - Real release signing config (signingConfigs.release pointing at the
    dev keystore in keystore/); keystore/release.jks gitignored;
    keystore/README.md documents generation & rotation.
  - KMP migration deferred to v0.5 (tracked in plan §10).

COMMUNITY / GITEA
  - .gitea/workflows/build.yml: assembleDebug on push & PR, APK as
    artefact.
  - CONTRIBUTING.md, CODE_OF_CONDUCT.md (Contributor Covenant v2.1),
    .gitea/ISSUE_TEMPLATE/{bug_report,feature_request}.yml,
    .gitea/PULL_REQUEST_TEMPLATE.md.
  - README: v0.2 changelog + Gitea remote-setup instructions.

VERIFIED
  - ./gradlew assembleDebug assembleRelease both green.
  - Debug APK 25.6 MB, release 19.8 MB, both v0.2 / versionCode 3.
  - apksigner verify: 'Verifies' / v2 scheme true.
  - No INTERNET permission in either APK (privacy posture unchanged).
2026-08-14 23:27:27 +12:00

5.0 KiB
Raw 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.

Code of Conduct

Everyone who participates in this project is expected to abide by the Contributor Covenant v2.1. Please read it before contributing.

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 so the changelog can be generated automatically later:

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.

AGPL-3.0 contribution terms

Incido is licensed under the GNU Affero 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 AGPL-3.0.
  2. You agree your contribution is licensed under AGPL-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 AGPL-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)

  1. Bump versionCode + versionName in app/build.gradle.kts.
  2. Update the Development Plan §10 history table.
  3. Tag the commit: git tag -s vX.Y.Z -m "vX.Y.Z — short summary".
  4. ./gradlew assembleRelease → upload APK to Gitea Releases.
  5. Push the tag: git push origin vX.Y.Z.

Thanks again for contributing! 🙏