diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..30ebe4c --- /dev/null +++ b/codecov.yml @@ -0,0 +1,14 @@ +coverage: + precision: 2 + round: nearest + range: "0..100" + status: + project: + default: + target: auto + threshold: 0.5% + patch: + default: + informational: true +comment: # this is a top-level key + layout: "diff, reach, files" diff --git a/detekt.yml b/detekt.yml new file mode 100644 index 0000000..e525c5e --- /dev/null +++ b/detekt.yml @@ -0,0 +1,22 @@ +# https://github.com/detekt/detekt/blob/main/detekt-core/src/main/resources/default-detekt-config.yml +# This file is used to override default detekt rules +# the rules are not listed here will be used from default detekt config listed in the link above + +config: + validation: true + warningsAsErrors: true + checkExhaustiveness: false + +style: + WildcardImport: + active: true + excludeImports: [ ] # default config excludes java.util.* + +complexity: + NamedArguments: + active: true + +naming: + FunctionNaming: + active: true + ignoreAnnotated: [ 'Composable' ] diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e050ebe..f4eacd7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -12,12 +12,12 @@ Example: ## Commit Message -Every commit message should match the following format `[Oztechan/TraceFit#ISSUE_ID] Commit message` +Every commit message should match the following format `[Oztechan/REPO_NAME#ISSUE_ID] Commit message` Example: ``` -[Oztechan/TraceFit#123] My cool feature +[Oztechan/Config#123] My cool feature ``` ## Pull Request @@ -27,23 +27,23 @@ Example: Pull Request title should follow below format: ``` -[Oztechan/TraceFit#ISSUE_ID] ISSUE_TITLE +[Oztechan/REPO_NAME#ISSUE_ID] ISSUE_TITLE ``` Example: ``` -[Oztechan/TraceFit#ISSUE_ID] Whatever the name of ticket is +[Oztechan/Config#123] Whatever the name of ticket is ``` ### Description -Description has to have `Resloves Oztechan/TraceFit#ISSUE_ID` with relevant issue. It will help automatically close relevant issue once the PR is merged. +Description has to have `Resloves Oztechan/REPO_NAME#ISSUE_ID` with relevant issue. It will help automatically close relevant issue once the PR is merged. Example: ``` -Resolves Oztechan/TraceFit#123 +Resolves Oztechan/Config#123 Some description. ``` diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md index 094e947..e487582 100644 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,12 @@ ## Description -Resolves Oztechan/TraceFit* +Resolves Oztechan/REPO_NAME#ISSUE_ID