Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (76 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

114 lines (76 loc) · 2.85 KB

Contributing to SafeBox

Thank you for considering contributing! SafeBox welcomes improvements, bug fixes, documentation updates, and feature ideas, especially from Android developers who care about performance and clean architecture.

Local Setup

git clone https://github.com/harrytmthy/safebox.git

Update pre-hook path

scripts/ contains shared pre-hooks for formatting and test validation. To enable it locally:

git config --local core.hooksPath scripts
chmod +x scripts/pre-commit
chmod +x scripts/pre-push

Run Spotless

./gradlew spotlessApply --init-script gradle/init.gradle.kts --no-configuration-cache

Commit & PR Guidelines

  • Use Conventional Commits (e.g. feat:, fix:, docs:, refactor:).
  • Keep PRs focused and small.
  • If your change affects the public API, update README.md or MIGRATION.md accordingly.
  • GitHub Actions will automatically run tests and checks upon opening or updating a PR.
  • Ensure all checks pass before merging.

Creating a PR

  1. Fork the repo and create your feature branch (git checkout -b feature/amazing-feature)
  2. Push your changes (git push origin feature/amazing-feature)
  3. Open a Pull Request against the main branch of the original repository

Testing

Run all tests locally with:

./gradlew testDebugUnitTest
./gradlew connectedAndroidTest

CI runs instrumented tests automatically on:

  • Android API 26
  • Android API 34

Contributor Etiquette

  • Discuss major changes or feature proposals first via Issues.
  • Be respectful during reviews! We're building something safe and friendly.
  • If anything is unclear, don't hesitate to ask!

Releasing (For Maintainers)

Only maintainers can perform releases.

1. Create a release branch

Create a branch from main using the following naming convention:

release/v1.2.0-alpha01

This branch will contain a single release commit.

2. Prepare the release commit

Update the following files in the same commit:

  • README.md
    Update the version in the Installation section:

    implementation("io.github.harrytmthy:safebox:1.2.0-alpha01")

  • :safebox/build.gradle.kts Set the new library version:

    version = "1.2.0-alpha01"

  • CHANGELOG.md
    Add a new section at the top with changes included in this release.

Commit message format:

release: v1.2.0-alpha01

3. Merge and tag

  • Open a Pull Request from release/v1.2.0-alpha01 into main
  • Once approved and merged, create and push a Git tag:
git tag v1.2.0-alpha01
git push origin v1.2.0-alpha01

This triggers the GitHub Action to publish the release to Maven Central.

Thanks again for contributing to SafeBox! You're helping shape a faster, safer Android future.