From a75d5bcf331b64e303b49715d978fa12be0ed0c5 Mon Sep 17 00:00:00 2001 From: pihme Date: Tue, 1 Mar 2022 13:06:26 +0100 Subject: [PATCH 1/8] chore(setup): add idea settings to align with automatic code formatting settings --- .gitignore | 6 +- .idea/codeStyles/Project.xml | 816 +++++++++++++++++++++++++++ .idea/codeStyles/codeStyleConfig.xml | 5 + .idea/externalDependencies.xml | 7 + .idea/google-java-format.xml | 6 + .idea/saveactions_settings.xml | 23 + 6 files changed, 862 insertions(+), 1 deletion(-) create mode 100644 .idea/codeStyles/Project.xml create mode 100644 .idea/codeStyles/codeStyleConfig.xml create mode 100644 .idea/externalDependencies.xml create mode 100644 .idea/google-java-format.xml create mode 100644 .idea/saveactions_settings.xml diff --git a/.gitignore b/.gitignore index d9d0dd88..2c2ff900 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,13 @@ .idea +!.idea/codeStyles +!.idea/externalDependencies.xml +!.idea/google-java-format.xml +!.idea/saveactions_settings.xml + target .classpath .checkstyle .project -.checkstyle .settings .factorypath build.properties diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml new file mode 100644 index 00000000..e58be92b --- /dev/null +++ b/.idea/codeStyles/Project.xml @@ -0,0 +1,816 @@ + + + + + diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 00000000..79ee123c --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/externalDependencies.xml b/.idea/externalDependencies.xml new file mode 100644 index 00000000..a9db6226 --- /dev/null +++ b/.idea/externalDependencies.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/.idea/google-java-format.xml b/.idea/google-java-format.xml new file mode 100644 index 00000000..2aa056da --- /dev/null +++ b/.idea/google-java-format.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/saveactions_settings.xml b/.idea/saveactions_settings.xml new file mode 100644 index 00000000..873570bb --- /dev/null +++ b/.idea/saveactions_settings.xml @@ -0,0 +1,23 @@ + + + + + + + From eea7e260233c3a9ed630ca076f350d46e35e9b7d Mon Sep 17 00:00:00 2001 From: pihme Date: Tue, 1 Mar 2022 13:09:04 +0100 Subject: [PATCH 2/8] chore(pom): refactor pom - bind spotless to process-sources phase - add markdown formatting on level of parent project - put java/pom formatting into the inheritable settings --- pom.xml | 59 +++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/pom.xml b/pom.xml index a4383805..5e47e707 100644 --- a/pom.xml +++ b/pom.xml @@ -283,6 +283,40 @@ + + + + com.diffplug.spotless + spotless-maven-plugin + ${plugin.version.spotless} + + + + + ${plugin.version.googlejavaformat} + + + + + + + false + true + true + + + + + + + apply + + process-sources + + + + + org.apache.maven.plugins @@ -315,26 +349,23 @@ spotless-maven-plugin ${plugin.version.spotless} - - - ${plugin.version.googlejavaformat} - - - - - - false - true - true - - + + + **/*.md + + + **/target/**/*.md + clients/go/vendor/**/*.md + + + apply - compile + process-sources From 1bdac6c081ff3dc43342d58ed31fe963bbbd5105 Mon Sep 17 00:00:00 2001 From: pihme Date: Tue, 1 Mar 2022 13:10:05 +0100 Subject: [PATCH 3/8] chore(format): apply markdown formatting --- .github/ISSUE_TEMPLATE/bug_report.md | 8 +++++- .github/ISSUE_TEMPLATE/general_issue.md | 1 + CONTRIBUTING.md | 18 ++++++++----- README.md | 34 ++++++++++++++++++------- 4 files changed, 45 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3ff104e6..a8f1eca5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,4 +1,5 @@ --- + name: Bug report about: Create a report to help us improve title: '' @@ -8,14 +9,16 @@ assignees: '' --- ## Description + ### Expected behaviour + ## Reproduction steps - +
Test code @@ -27,6 +30,7 @@ assignees: ''
Process + ```xml @@ -35,5 +39,7 @@ assignees: ''
## Environment + - OS: - Version: + diff --git a/.github/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md index 2000a102..b3917134 100644 --- a/.github/ISSUE_TEMPLATE/general_issue.md +++ b/.github/ISSUE_TEMPLATE/general_issue.md @@ -1,4 +1,5 @@ --- + name: General issue about: General changes to the project title: '' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77c45207..d70f3d32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ the test code. Every issue should have a meaningful name and a description which either describes: - a new feature with details about the use case the feature would solve or - improve +improve - a problem, how we can reproduce it and what would be the expected behavior ## Starting on an issue @@ -37,11 +37,13 @@ To work on an issue, follow the following steps: 1. Check that a [GitHub issue][issues] exists for the task you want to work on. If this is not the case, please create one. 2. Checkout the `main` branch and pull the latest changes. + ``` git checkout main git pull ``` 3. Create a new branch with the naming scheme `issueId-description`. + ``` git checkout -b 123-add-process-assertion` ``` @@ -49,6 +51,7 @@ To work on an issue, follow the following steps: and [Zeebe Code Style](https://github.com/zeebe-io/zeebe/wiki/Code-Style) while coding. 5. Implement the required changes on your branch and regularly push your changes to the origin so that the CI can run. + ``` git commit -am 'feat: add process assertion' git push -u origin 123-add-process-assertion @@ -60,6 +63,7 @@ To work on an issue, follow the following steps: that you should think about how a reviewer can best understand your changes. Please follow the [commit message guidelines](#commit-message-guidelines). 7. After finishing up the squashing force push your changes to your branch. + ``` git push --force-with-lease ``` @@ -77,10 +81,10 @@ To work on an issue, follow the following steps: you either feedback or accept the changes. Your reviewer might use [emoji code](https://devblogs.microsoft.com/appcenter/how-the-visual-studio-mobile-center-team-does-code-review/#introducing-the-emoji-code) during the reviewing process. - 1. If there are changes requested address them in a new commit. Notify the - reviewer in a comment if the pull request is ready for review again. If - the changes are accepted squash them again in the related commit and force push. - 2. If no changes are requested the reviewer will merge your changes. +4. If there are changes requested address them in a new commit. Notify the + reviewer in a comment if the pull request is ready for review again. If + the changes are accepted squash them again in the related commit and force push. +5. If no changes are requested the reviewer will merge your changes. ## Commit Message Guidelines @@ -94,8 +98,8 @@ Commit messages use [Conventional Commits](https://www.conventionalcommits.org/e