Skip to content

Commit

Permalink
Add a Building section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
cortinico committed Aug 3, 2020
1 parent a920abc commit 63369e0
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ _A fork of [Chuck](https://github.com/jgilfelt/chuck)_
* [Snapshots](#snapshots-)
* [FAQ](#faq-)
* [Contributing](#contributing-)
* [Building](#building-)
* [Acknowledgments](#acknowledgments-)
* [License](#license-)

Expand Down Expand Up @@ -188,6 +189,28 @@ Short `TODO` List for new contributors:
- Increment the test coverage.
- [Issues marked as `Help wanted`](https://github.com/ChuckerTeam/chucker/labels/help%20wanted)

### Building 🛠

In order to start working on Chucker, you need to fork the project and open it in Android Studio/IntelliJ IDEA.

Before committing we suggest you install the `ktlint` pre-commit hooks, with the following command:

```
./gradlew addKtlintFormatGitPreCommitHook
```

This will make sure your code is reformatted before every commit (if you just want to be warned about formatting issues you can run
`addKtlintCheckGitPreCommitHook`).

Before submitting a PR please run:

```
./gradlew build
```

This will build the library and will run all the verification tasks (ktlint, detekt, lint, unit tests) locally.
This will make sure your CI checks will pass.

## Acknowledgments 🌸

### Maintainers
Expand Down
1 change: 1 addition & 0 deletions library-no-op/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ android {
lintOptions {
warningsAsErrors true
abortOnError true
disable 'GradleDependency'
}
}

Expand Down
1 change: 1 addition & 0 deletions library/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ android {
lintOptions {
warningsAsErrors true
abortOnError true
disable 'GradleDependency'
}

testOptions {
Expand Down
1 change: 1 addition & 0 deletions sample/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ android {
lintOptions {
warningsAsErrors true
abortOnError true
disable 'GradleDependency'
}
}

Expand Down

0 comments on commit 63369e0

Please sign in to comment.