Per-version user-facing changelog moved out of the README table into PREVIOUS_HISTORY.md (newest-first sections, Development Plan §11.1). On tag push the workflow now harvests the matching section via scripts/ci/release-notes.py and uses it as the release description, uploading an Incido-<version>-changes.md beside the APKs; a missing section falls back to the plain default description. CONTRIBUTING §5 documents the new release-notes maintenance step.
5.5 KiB
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 infooradb 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 issueorhelp wantedlabels. - 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-starsfix/editor-ime-on-android-12refactor/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/domainorcore/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:
| 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:
- The contribution is your own original work, or you have the right to submit it under the GPL-3.0.
- 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
Modifierparameter orderingModifier.size().background().clickable(). - Imports: Wildcard imports are discouraged. Group: Android → Compose → third-party → internal.
- Naming:
PascalCasefor types,camelCasefor functions/properties,UPPER_SNAKE_CASEfor 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.MAINTENANCEare normal release numbers;EMERGENCYis non-zero only for hotfixes shipped out-of-band.versionCodeis a monotonic int and always +1 per release. A build with aversionNamethat doesn't match^\d+\.\d+\.\d+\.\d+$fails immediately — there's a validator inapp/build.gradle.kts.
- Bump
versionCode(+1) andversionNameinapp/build.gradle.kts. - Update the Development Plan §10 history table with the new dot-name.
- Tag the commit:
git tag -s vX.Y.Z.W -m "vX.Y.Z.W — short summary". ./gradlew assembleDebug assembleRelease— confirm both green.- Upload
app/build/outputs/apk/release/app-release.apkto Gitea Releases. - Push the tag:
git push origin vX.Y.Z.W.
Thanks again for contributing! 🙏