arch-toolkit
Arch Toolkit · Contribution Guide
Objective
Explain how to contribute safely without breaking published APIs while maintaining the Kotlin Multiplatform-first vision.
Installation
Clone the repository and bootstrap Gradle:
git clone https://github.com/matheus-corregiari/arch-toolkit.git
cd arch-toolkit
./gradlew tasks
Install the recommended toolchain:
- JDK: 17+
- Kotlin: Managed by the Gradle wrapper (see
gradle/libs.versions.toml). - Android Studio / IntelliJ IDEA: For IDE inspections and Compose previews.
Usage Examples
Follow these practices when contributing:
- Target KMP first – add behavior to shared modules before platform-specific forks.
- Keep implementations untouched unless you pair them with unit tests and documentation updates.
- Write tests – place them under the relevant
commonTest,androidUnitTest, oriosTestsource set. - Run CI locally –
./gradlew clean checkcovers lint, tests, and static analysis. - Document your changes – update the module README and wiki pages if workflows change.
License
By contributing, you agree that your code will be released under the Apache License 2.0.
Pull Request Checklist
- Tests cover new behaviour.
- Documentation updated (README, KDoc, or wiki).
- No implementation regressions (verify with
./gradlew check). - Changelog entry or release note proposed when applicable.