docs: add CONTRIBUTING.md and update README.md

Signed-off-by: Artyom Shendrik <[email protected]>

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing guidelines
+
+Please make every effort to follow existing conventions and style to keep the code
+as readable as possible.
+
+Please also make sure your code is ready by running:<br>
+`./gradlew check`.
+
+- In case of updated dependencies, don't forget to call `./gradlew dependencyGuardBaseline`
+
+- Get working code on a personal branch with all tests before you submit a PR.
+
+- Please, try to keep the git history flat and clean. Avoid merge commits (except for hotfix branches).
+
+- Use [conventional commits](https://conventionalcommits.org/) specification for commit messages.
+Please, use this format for PR titles too.
+
+**The expected commit message format is:**
+
+> type(scope): description
+* The `type` MUST be one of: `feat`, `fix`, `test`, `build`, `ci`, `docs`, `perf`, `refactor`, `style`, `chore`, `i18n`, `deps`, `misc`.
+* The `scope` is optional, but recommended. Any string is allowed; it should indicate what the change affects.
+* The `description` MUST be pithy and direct short summary of the code changes.
+* The `description` MUST be in the imperative, present tense: "change" not "changed" nor "changes".
+* A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
+* One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :<space> or <space># separator, followed by a string value.
+* The `BREAKING CHANGE` footer MAY be provided if this commit introduces a breaking change. The `BREAKING CHANGE` footer MUST contain a description of the breaking changes, a justification for why the breaking changes were introduced and any migration notes required.
+* See [conventionalcommits.org](https://conventionalcommits.org/) for more details.
+
+<small>_The [commitizen CLI](https://github.com/commitizen/cz-cli) can help to construct these commit messages (but it's not required)._</small>
+
+Examples:
+* `build(deps): bump Name Of Lib version to "17.0.2"`
+* `docs: fix a typo in README.md`

README.md

@@ -6,8 +6,8 @@
 [![Common Changelog](https://common-changelog.org/badge.svg)](CHANGELOG.md)
 
 [![Kotlin](http://img.shields.io/badge/Kotlin-1.9.20-7F52FF?logo=kotlin&logoWidth=10&logoColor=7F52FF&labelColor=2B2B2B)](https://github.com/JetBrains/Kotlin)
-[![Gradle](http://img.shields.io/badge/Gradle-8.4-f68244?logo=gradle&labelColor=2B2B2B)](https://gradle.org/releases/)
-[![Android Gradle Plugin](http://img.shields.io/badge/Android--Gradle--Plugin-8.1.2-0E3B1A?logo=android&labelColor=2B2B2B)](https://mvnrepository.com/artifact/com.android.tools.build/gradle?repo=google)
+[![Gradle](http://img.shields.io/badge/Gradle-8.5-f68244?logo=gradle&labelColor=2B2B2B)](https://gradle.org/releases/)
+[![Android Gradle Plugin](http://img.shields.io/badge/Android--Gradle--Plugin-8.1-0E3B1A?logo=android&labelColor=2B2B2B)](https://mvnrepository.com/artifact/com.android.tools.build/gradle?repo=google)
 
 Convenience Gradle plugin for reliable configuration of Kotlin & KMP projects.
 
@@ -57,7 +57,7 @@ pluginManagement {
   }
   resolutionStrategy.eachPlugin {
     if (requested.id.toString() == "io.github.fluxo-kt.fluxo-kmp-conf")
-      useModule("com.github.fluxo-kt.fluxo-kmp-conf:fluxo-kmp-conf:8521cd7e0a") // <-- specify version or commit
+      useModule("com.github.fluxo-kt.fluxo-kmp-conf:fluxo-kmp-conf:3002cb3137") // <-- specify version or commit
   }
 }
 ```