Files
Incido/CONTRIBUTING.md
T
Incido Developer d616ce3021 feat: v0.3.0.0 — hashtags (visible on editor) + bolder colour accent + centred title + nav drawer + new version scheme
v0.3.0.0 bundles four user-facing features, the plan-compliance polish
that was deferred from v0.2, and a permanent change to how we name
releases going forward.

VERSION SCHEME (app/build.gradle.kts)
  - versionName = '0.3.0.0' (MAJOR.MINOR.MAINTENANCE.EMERGENCY)
  - versionCode = 5
  - New gradle taskGraph validator fails the build if versionName
    doesn't match ^\d+\.\d+\.\d+\.\d+$ — we can't accidentally
    regress the scheme.
  - History re-keyed across README, Plan §10, CONTRIBUTING.md.

HASHTAGS
  - value class Hashtag (domain/model) with normalise/parseOrNull
    helpers; pattern: ^[a-z0-9][a-z0-9._-]{0,30}$
  - data class HashtagUsage (name, noteCount, lastUsedAt)
  - sealed class NoteFilter { Home, Favorites, Untagged, ByTag(name) }
  - Note gains hashtags: List<String> (sorted ascending)
  - Repository:
      - new entities HashtagEntity (@Index on name) and
        NoteHashtagCrossRef (many-to-many junction)
      - new methods: observeFavorites / observeUntagged /
        observeNotesForHashtag / observeHashtagsByRecentUse /
        observeAllHashtags / searchHashtags / addHashtag / removeHashtag
      - search() now matches content OR hashtag-name (case-insensitive)
      - ObjectBox queries use explicit StringOrder + type annotations
        (kapt's stubs are finicky around Property<String> overloads)

UI
  - CenterAlignedTopAppBar on both list and editor screens
  - List:
      - Hamburger top-left opens a ModalNavigationDrawer (Home /
        Favorites / Untagged / divider / scrollable Recent tags)
      - Drawer selection drives a NoteFilter state held at root
      - Search bar visible only when filter == Home
      - NoteCard redesign — 14 dp vertical gradient stripe +
        tinted surface (12 % colour blend) + 10 dp corner chip
      - Empty-state copy is filter-aware
  - Editor:
      - Persistent hashtag chip row above the text field
      - Tag # icon in the top bar + '+ add' chip opens a ModalBottomSheet
      - Autocomplete suggestions live from repository.searchHashtags
      - '+ Create name' button when the typed value is valid + new
      - Snackbar 'Maximum 5 tags reached.' when the cap is hit
      - Reconciled on save via addHashtag / removeHashtag diff

DOCS
  - README v0.3.0.0 section + re-keyed changelog
  - Development Plan §10 history re-keyed (0.1.0.0 / 0.1.1.0 /
    0.2.0.0 / 0.2.0.1 / 0.3.0.0)
  - CONTRIBUTING.md release-process note updated for the new scheme

VERIFIED
  - ./gradlew assembleDebug assembleRelease both green
  - Debug 25.7 MB, release 19.8 MB (v2-signed)
  - versionCode=5, versionName='0.3.0.0'
  - No INTERNET permission
  - Validator regression: setting versionName='0.3' causes
    assembleDebug to fail with the new scheme error message
2026-08-15 02:02:53 +12:00

5.5 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)

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.
  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! 🙏