Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING to add kdoctor installation requirement. #1025

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Update CONTRIBUTING to add kdoctor installation requirement. #1025

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3be28
Update CONTRIBUTING to add kdoctor installation requirement.
waylon-brown Nov 28, 2023
d343798
Update .github/CONTRIBUTING.md
waylon-brown Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ discussion.

## Development

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

Circuit is a Kotlin Multiplatform project, so ensure you have your environment set up
accordingly: https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-setup.html

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](https://github.com/diffplug/spotless). To run the formatter,
use the `spotlessApply` command.
Code formatting is checked via [Spotless](https://github.com/diffplug/spotless). To run the
formatter, use the `spotlessApply` command.

```bash
./gradlew spotlessApply
Expand Down