Contributors Guide

Note that this project is considered READ-ONLY. You are welcome to discuss or ask questions in the discussions section of the repo, but we do not normally accept external contributions without prior discussion.

Development

Check out this repo with Android Studio. It’s a standard gradle project and conventional to checkout.

The primary project is circuit. The primary sample is samples/star.

This project is written in Kotlin and should only use Kotlin.

Code formatting is checked via Spotless. To run the formatter, use the spotlessApply command.

./gradlew spotlessApply