From 97687e2ceea9657036d930233287f2728d1d05ea Mon Sep 17 00:00:00 2001 From: Mohsen Rzna Date: Fri, 5 Apr 2024 23:19:11 +0200 Subject: [PATCH 1/5] Readme update --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 16 ++++++++++++---- 2 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6ae49fd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +## Thanks for thinking about this :) + +You can contribute to this library by filing issues, bugs and Pull requests. + +### Code contribution + +- Open issue/Pull request regarding proposed change. +- If your proposed change is approved, Fork this repo and do changes. +- Open Pull request against latest *development* branch. Add nice description in PR. +- And that's it! + +### Code contribution checklist + +- New code addition/deletion should not break existing flow of a system. +- All tests should be passed. +- Verify `./gradlew detekt` is passing before creating a Pull request. diff --git a/README.md b/README.md index 2851448..f53f044 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # 📘 Reusable Components library for Compose -![master CI](https://github.com/LinX64/Reusable/actions/workflows/publish.yaml/badge.svg) -![develop CI](https://github.com/LinX64/Reusable/actions/workflows/ci.yaml/badge.svg) -[![Maven Central](https://img.shields.io/maven-central/v/io.github.linx64/reusablecomponents.svg)](https://central.sonatype.com/artifact/io.github.linx64/reusablecomponents/overview) +
+ master CI + develop CI + + Maven Central + +
This library is a treasure trove of reusable components tailored for Jetpack Compose, designed to simplify the creation of complex interfaces. It's your go-to toolkit for crafting visually stunning @@ -57,9 +61,13 @@ And that's it! You have a scrollable screen with a few buttons. You can customiz passing your own `modifier` to it. The same goes for the buttons, you can pass your own `modifier` to it. -**Important note:** To use the Preview components, you'll nned to add your own theme first, then use the +**Important note:** To use the Preview components, you'll need to add your theme first, then use the components to create your UI. +## 🙋‍Contributing + +Please Read [contribution guidelines](CONTRIBUTING.md) for more information regarding contribution. + ## License This library is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more From 45bf835fbb7965d1d90cf38d9227fe17569e94b9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 5 Apr 2024 21:21:07 +0000 Subject: [PATCH 2/5] Update dependency io.github.linx64:reusablecomponents to v1.1.2 --- gradle/libs.versions.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 92ec143..249b610 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -8,7 +8,7 @@ composeBom = "2024.04.00" material-3 = "1.2.1" detekt = "1.23.6" mavenPublish = "0.28.0" -reuseableComponents = "1.1.1" +reuseableComponents = "1.1.2" [libraries] androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" } From e6f4b6606bc5f62facbd45f82a435c345d258603 Mon Sep 17 00:00:00 2001 From: Mohsen Rezania Date: Fri, 5 Apr 2024 23:21:30 +0200 Subject: [PATCH 3/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ae49fd..8c3973a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,16 @@ ## Thanks for thinking about this :) -You can contribute to this library by filing issues, bugs and Pull requests. +You can contribute to this library by filing issues, bugs, and Pull requests. ### Code contribution -- Open issue/Pull request regarding proposed change. -- If your proposed change is approved, Fork this repo and do changes. -- Open Pull request against latest *development* branch. Add nice description in PR. +- Open issue/Pull request regarding the proposed change. +- If your proposed change is approved, Fork this repo and make changes. +- Open Pull request against latest *development* branch. Add a nice description in PR. - And that's it! -### Code contribution checklist +### Contribution checklist -- New code addition/deletion should not break existing flow of a system. +- New code addition/deletion should not break the existing flow of a system. - All tests should be passed. - Verify `./gradlew detekt` is passing before creating a Pull request. From 3e21f5ceacfd2de40b2f6a3ea654eb7a507320fb Mon Sep 17 00:00:00 2001 From: Mohsen Rezania Date: Fri, 5 Apr 2024 23:21:52 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f53f044..ae6f89f 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ to it. **Important note:** To use the Preview components, you'll need to add your theme first, then use the components to create your UI. -## 🙋‍Contributing +## 🙋‍Contributing -Please Read [contribution guidelines](CONTRIBUTING.md) for more information regarding contribution. +Please read [contribution guidelines](CONTRIBUTING.md) for more information regarding contribution. ## License From 6073dd853a9011063c64b4ee08b6405a6dd0b1d9 Mon Sep 17 00:00:00 2001 From: Mohsen Rzna Date: Fri, 5 Apr 2024 23:26:53 +0200 Subject: [PATCH 5/5] Updating publish script --- .github/workflows/publish.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 6d44ab2..1ed8ea4 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,12 +1,6 @@ name: Publish on: - push: - tags: - - v* - branches: - - master - workflow_dispatch: inputs: should-publish: