From 62b96349be3e7c012096c60e247cf9ab328de281 Mon Sep 17 00:00:00 2001 From: Nicola Corti Date: Mon, 3 Aug 2020 19:00:53 +0200 Subject: [PATCH 1/3] Add a Building section to the README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index f0157a130..1ab9ce333 100644 --- a/README.md +++ b/README.md @@ -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-) @@ -188,6 +189,27 @@ 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 pre-commit hooks with the following command: + +``` +./gradlew installGitHook +``` + +This will make sure your code is validated against KtLint and Detekt before every commit. + +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 From ce8381d29002ba9ee2aefbb412d29c2fdb31fbe3 Mon Sep 17 00:00:00 2001 From: Nicola Corti Date: Wed, 5 Aug 2020 08:18:17 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1ab9ce333..ce1990f11 100644 --- a/README.md +++ b/README.md @@ -200,6 +200,7 @@ Before committing we suggest you install the pre-commit hooks with the following ``` This will make sure your code is validated against KtLint and Detekt before every commit. +The command will run automatically before the `clean` task, so you should have the pre-commit installed by then. Before submitting a PR please run: From 1ea8b46387d8fc00ab7f7938dc1c2826080fac97 Mon Sep 17 00:00:00 2001 From: Nicola Corti Date: Fri, 7 Aug 2020 16:43:31 +0200 Subject: [PATCH 3/3] Update README.md Co-authored-by: Volodymyr Buberenko --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ce1990f11..6c69608c5 100644 --- a/README.md +++ b/README.md @@ -200,7 +200,7 @@ Before committing we suggest you install the pre-commit hooks with the following ``` This will make sure your code is validated against KtLint and Detekt before every commit. -The command will run automatically before the `clean` task, so you should have the pre-commit installed by then. +The command will run automatically before the `clean` task, so you should have the pre-commit hook installed by then. Before submitting a PR please run: