From 2c9f985e78e21c62f51ff1dee9bbd8c3a9c18eac Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Thu, 6 Oct 2022 15:45:57 -0400 Subject: [PATCH 1/2] chore: CONTRIBUTING.md dep Signed-off-by: Todd Baert --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 921b6cc91..8411fcffa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,9 +81,14 @@ Use `mvn --projects {MODULE PATH} clean verify` to test/audit/lint just a single As described in the [README](./README.md), this project uses release-please, and semantic versioning. Breaking changes should be identified by using a semantic PR title. + +## Dependencies + +Keep dependencies to a minimum, especially `compile` dependencies. Do not include dependencies specific to your module in the parent, add them to your module's `POM.xml`. +The Java-SDK should be a _provided_ of your module, the parent POM takes care of this automatically. Keep in mind, one version of the Java-SDK is used for all modules. -### VS Code config +## VS Code config To use vscode, install the standard [Java language support extension by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java). From 2e9062adbb1e18688a94054ae3d4b0cddb170ce3 Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Thu, 6 Oct 2022 15:48:44 -0400 Subject: [PATCH 2/2] fixup: add a word Signed-off-by: Todd Baert --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8411fcffa..b3cae1db8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,7 +85,7 @@ Breaking changes should be identified by using a semantic PR title. ## Dependencies Keep dependencies to a minimum, especially `compile` dependencies. Do not include dependencies specific to your module in the parent, add them to your module's `POM.xml`. -The Java-SDK should be a _provided_ of your module, the parent POM takes care of this automatically. +The Java-SDK should be a _provided_ dependency of your module, the parent POM takes care of this automatically. Keep in mind, one version of the Java-SDK is used for all modules. ## VS Code config