Files
Incido/CONTRIBUTING.md
T

152 lines
5.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 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](.gitea/ISSUE_TEMPLATE/bug_report.yml) 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](.gitea/ISSUE_TEMPLATE/feature_request.yml).
Before you do, check the existing issues and the
[Development Plan](./Incido%20Development%20Plan.txt) §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
```bash
./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](https://www.conventionalcommits.org/) 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](./.gitea/PULL_REQUEST_TEMPLATE.md).
- 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](https://kotlinlang.org/docs/coding-conventions.html).
- **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! 🙏