Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 826 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 826 Bytes

Contributing

Thanks for your interest in contributing to ThreadsVault.

Setup

  1. Use Android Studio stable.
  2. Use JDK 17.
  3. Install Android SDK 35.
  4. Run:
./gradlew :app:assembleDebug

Workflow

  1. Fork the repository.
  2. Create a feature branch:
git checkout -b feat/your-change
  1. Keep PRs focused and small.
  2. Add/adjust tests when behavior changes.
  3. Ensure project compiles before opening PR.

Code style

  • Kotlin + Jetpack Compose conventions.
  • Keep UI logic readable and composables focused.
  • Prefer clear naming over clever abstractions.

Commit messages

Use short, descriptive commits. Example:

feat(vault): add about dev entry in settings

Pull requests

  • Explain what changed and why.
  • Include screenshots for UI changes.
  • Mention any known limitations.