kbowers-ibm commented on code in PR #6866:
URL:
https://github.com/apache/incubator-kie-drools/pull/6866#discussion_r3705144620
##########
CONTRIBUTING.md:
##########
@@ -130,79 +129,96 @@ Any dependency used in any KOGITO projects should fulfill
these soft requirement
- Both are bad because they cause dependency tree trouble. Use the non-fat
jar instead, for example: `weld-se-core.jar`
There are currently a few dependencies which violate some of these rules. They
should be properly commented with a
-warning and explaining why are needed
+warning and explaining why are needed.
If you want to add a dependency that violates any of the rules above, get
approval from the project leads.
-### Tests and Documentation
+### Tests and Documentation
-Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...). Guides and reference documentation
should be submitted to the [Kogito Docs
Repository](https://github.com/kiegroup/kie-docs/tree/main-kogito).
-If you are contributing a new feature, we strongly advise submitting an
[Example](https://github.com/kiegroup/kogito-examples).
+Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...).
+Guides and reference documentation should be submitted to the [Apache KIE docs
repository](https://github.com/apache/incubator-kie-docs).
- For Quarkus tests, basically use `@QuarkusTest` as unit tests for
surefire-plugin and `@QuarkusIntegrationTest` as integration tests (`*IT.java`)
for failsafe-plugin. Static http resources generated by `kogito-codegen`
(`META-INF/resources/`) are available with `@QuarkusIntegrationTest`. If you
need to access static http resources in `@QuarkusTest`, add `quarkus-undertow`
dependency with `test` scope. Also note that you cannot mix `@QuarkusTest` and
`@QuarkusIntegrationTest` in the same `integration-test` phase.
### Code Reviews and Continuous Integration
-All submissions, including those by project members, need to be reviewed by
others before being merged. Our CI, Jenkins, should successfully execute your
PR, marking the GitHub check as green.
+All submissions, including those by project members, need to be reviewed by
others before being merged.
+Our CI runs on GitHub Actions and should successfully execute your PR, marking
the GitHub checks as green — see
+[docs/PR_CHECKS_AND_CI.md](./docs/PR_CHECKS_AND_CI.md) for what runs on pull
requests.
## Feature Proposals
-If you would like to see some feature in Kogito, start with an email to [our
mailing list](https://groups.google.com/forum/#!forum/kogito-development) or
just [pop into our Zulip chat](https://kie.zulipchat.com/) and tell us what you
would like to see.
+If you would like to see some feature in Apache KIE, start with an email to the
+[dev mailing list](mailto:[email protected])
([subscribe](mailto:[email protected]))
+or just pop into our [Zulip chat](https://kie.zulipchat.com/) and tell us what
you would like to see.
-Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it. If the feature is deemed worthy, then an
[**Epic**](https://issues.redhat.com/issues/?filter=12347334) will be created.
+Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it.
## Setup
If you have not done so on this machine, you need to:
-
+
* Install Git and configure your GitHub access
* Install Java SDK (OpenJDK recommended)
* For Native Image, follow Quarkus instructions at
[GraalVM](https://quarkus.io/guides/building-native-image)
-* On MAC, check [Setup MAC for Native image build](./Develop_on_Mac.md) for
further instructions.
+* On macOS, check [Developing on macOS](./docs/DEVELOP_ON_MACOS.md) for
further instructions.
-Docker is not strictly necessary, but it is a required to run some of the
integration tests.
-These tests can be skipped (see the [Build](#build) section), but we recommend
to install it to run these tests locally.
+Docker is not strictly necessary, but it is required to run some of the
integration tests.
+These tests can be skipped, but we recommend to install it to run these tests
locally.
Review Comment:
```suggestion
These tests can be skipped, but we recommend installing it to run these
tests locally.
```
##########
CONTRIBUTING.md:
##########
@@ -130,79 +129,96 @@ Any dependency used in any KOGITO projects should fulfill
these soft requirement
- Both are bad because they cause dependency tree trouble. Use the non-fat
jar instead, for example: `weld-se-core.jar`
There are currently a few dependencies which violate some of these rules. They
should be properly commented with a
-warning and explaining why are needed
+warning and explaining why are needed.
Review Comment:
```suggestion
warning and an explanation as to why they are needed.
```
##########
CONTRIBUTING.md:
##########
@@ -130,79 +129,96 @@ Any dependency used in any KOGITO projects should fulfill
these soft requirement
- Both are bad because they cause dependency tree trouble. Use the non-fat
jar instead, for example: `weld-se-core.jar`
There are currently a few dependencies which violate some of these rules. They
should be properly commented with a
-warning and explaining why are needed
+warning and explaining why are needed.
If you want to add a dependency that violates any of the rules above, get
approval from the project leads.
-### Tests and Documentation
+### Tests and Documentation
-Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...). Guides and reference documentation
should be submitted to the [Kogito Docs
Repository](https://github.com/kiegroup/kie-docs/tree/main-kogito).
-If you are contributing a new feature, we strongly advise submitting an
[Example](https://github.com/kiegroup/kogito-examples).
+Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...).
+Guides and reference documentation should be submitted to the [Apache KIE docs
repository](https://github.com/apache/incubator-kie-docs).
- For Quarkus tests, basically use `@QuarkusTest` as unit tests for
surefire-plugin and `@QuarkusIntegrationTest` as integration tests (`*IT.java`)
for failsafe-plugin. Static http resources generated by `kogito-codegen`
(`META-INF/resources/`) are available with `@QuarkusIntegrationTest`. If you
need to access static http resources in `@QuarkusTest`, add `quarkus-undertow`
dependency with `test` scope. Also note that you cannot mix `@QuarkusTest` and
`@QuarkusIntegrationTest` in the same `integration-test` phase.
### Code Reviews and Continuous Integration
-All submissions, including those by project members, need to be reviewed by
others before being merged. Our CI, Jenkins, should successfully execute your
PR, marking the GitHub check as green.
+All submissions, including those by project members, need to be reviewed by
others before being merged.
+Our CI runs on GitHub Actions and should successfully execute your PR, marking
the GitHub checks as green — see
+[docs/PR_CHECKS_AND_CI.md](./docs/PR_CHECKS_AND_CI.md) for what runs on pull
requests.
## Feature Proposals
-If you would like to see some feature in Kogito, start with an email to [our
mailing list](https://groups.google.com/forum/#!forum/kogito-development) or
just [pop into our Zulip chat](https://kie.zulipchat.com/) and tell us what you
would like to see.
+If you would like to see some feature in Apache KIE, start with an email to the
+[dev mailing list](mailto:[email protected])
([subscribe](mailto:[email protected]))
+or just pop into our [Zulip chat](https://kie.zulipchat.com/) and tell us what
you would like to see.
-Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it. If the feature is deemed worthy, then an
[**Epic**](https://issues.redhat.com/issues/?filter=12347334) will be created.
+Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it.
## Setup
If you have not done so on this machine, you need to:
-
+
* Install Git and configure your GitHub access
* Install Java SDK (OpenJDK recommended)
* For Native Image, follow Quarkus instructions at
[GraalVM](https://quarkus.io/guides/building-native-image)
-* On MAC, check [Setup MAC for Native image build](./Develop_on_Mac.md) for
further instructions.
+* On macOS, check [Developing on macOS](./docs/DEVELOP_ON_MACOS.md) for
further instructions.
-Docker is not strictly necessary, but it is a required to run some of the
integration tests.
-These tests can be skipped (see the [Build](#build) section), but we recommend
to install it to run these tests locally.
+Docker is not strictly necessary, but it is required to run some of the
integration tests.
+These tests can be skipped, but we recommend to install it to run these tests
locally.
* Check [the installation guide](https://docs.docker.com/install/), and [the
MacOS installation guide](https://docs.docker.com/docker-for-mac/install/)
-* If you just install docker, be sure that your current user can run a
container (no root required).
+* If you just install docker, be sure that your current user can run a
container (no root required).
On Linux, check [the post-installation
guide](https://docs.docker.com/install/linux/linux-postinstall/)
-
## Build
-* Clone the repository, navigate to the directory, invoke `./mvnw clean
install -Dquickly` from the root directory.
+Clone the repository, navigate to the directory, and build with the Maven
wrapper:
```bash
-git clone https://github.com/kiegroup/kogito-runtimes.git
-cd kogito-runtimes
-./mvnw clean install -Dquickly
+git clone https://github.com/apache/incubator-kie-drools.git
Review Comment:
```suggestion
git clone https://github.com/apache/incubator-kie.git
```
##########
CONTRIBUTING.md:
##########
@@ -113,12 +111,13 @@ Any dependency used in any KIE project must fulfill these
hard requirements:
- Since we may need to rebuild the dependency from sources, we also need
to make sure it is easily buildable.
Maven or Gradle are acceptable as build systems.
-Any dependency used in any KOGITO projects should fulfill these soft
requirements:
-- **Edit dependencies** in
**[kogito-build-parent](https://github.com/kiegroup/kogito-runtimes/blob/main/kogito-build/kogito-build-parent/pom.xml)**.
- - Dependencies in subprojects should avoid overwriting the dependency
versions of kogito-build-parent if there is no special case or need for that.
+Any dependency used in any KIE project should fulfill these soft requirements:
+
+- **Edit dependencies in the appropriate BOM or build parent** — see
+ [docs/STRUCTURE.md](./docs/STRUCTURE.md#parent-poms-and-boms).
+ - Dependencies in subprojects should avoid overwriting the dependency
versions of their build parent if there is no special case or need for that.
- Only use dependencies with **an active community**.
- - Check for activity in the last year through [Open
Hub](https://www.openhub.net).
Review Comment:
Just confirming this is intentional
##########
CONTRIBUTING.md:
##########
@@ -130,79 +129,96 @@ Any dependency used in any KOGITO projects should fulfill
these soft requirement
- Both are bad because they cause dependency tree trouble. Use the non-fat
jar instead, for example: `weld-se-core.jar`
There are currently a few dependencies which violate some of these rules. They
should be properly commented with a
-warning and explaining why are needed
+warning and explaining why are needed.
If you want to add a dependency that violates any of the rules above, get
approval from the project leads.
-### Tests and Documentation
+### Tests and Documentation
-Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...). Guides and reference documentation
should be submitted to the [Kogito Docs
Repository](https://github.com/kiegroup/kie-docs/tree/main-kogito).
-If you are contributing a new feature, we strongly advise submitting an
[Example](https://github.com/kiegroup/kogito-examples).
+Don't forget to include tests in your pull requests, and documentation
(reference documentation, javadoc...).
+Guides and reference documentation should be submitted to the [Apache KIE docs
repository](https://github.com/apache/incubator-kie-docs).
- For Quarkus tests, basically use `@QuarkusTest` as unit tests for
surefire-plugin and `@QuarkusIntegrationTest` as integration tests (`*IT.java`)
for failsafe-plugin. Static http resources generated by `kogito-codegen`
(`META-INF/resources/`) are available with `@QuarkusIntegrationTest`. If you
need to access static http resources in `@QuarkusTest`, add `quarkus-undertow`
dependency with `test` scope. Also note that you cannot mix `@QuarkusTest` and
`@QuarkusIntegrationTest` in the same `integration-test` phase.
### Code Reviews and Continuous Integration
-All submissions, including those by project members, need to be reviewed by
others before being merged. Our CI, Jenkins, should successfully execute your
PR, marking the GitHub check as green.
+All submissions, including those by project members, need to be reviewed by
others before being merged.
+Our CI runs on GitHub Actions and should successfully execute your PR, marking
the GitHub checks as green — see
+[docs/PR_CHECKS_AND_CI.md](./docs/PR_CHECKS_AND_CI.md) for what runs on pull
requests.
## Feature Proposals
-If you would like to see some feature in Kogito, start with an email to [our
mailing list](https://groups.google.com/forum/#!forum/kogito-development) or
just [pop into our Zulip chat](https://kie.zulipchat.com/) and tell us what you
would like to see.
+If you would like to see some feature in Apache KIE, start with an email to the
+[dev mailing list](mailto:[email protected])
([subscribe](mailto:[email protected]))
+or just pop into our [Zulip chat](https://kie.zulipchat.com/) and tell us what
you would like to see.
-Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it. If the feature is deemed worthy, then an
[**Epic**](https://issues.redhat.com/issues/?filter=12347334) will be created.
+Great feature proposals should include a short **Description** of the feature,
the **Motivation** that makes that feature necessary and the **Goals** that are
achieved by realizing it.
## Setup
If you have not done so on this machine, you need to:
-
+
* Install Git and configure your GitHub access
* Install Java SDK (OpenJDK recommended)
* For Native Image, follow Quarkus instructions at
[GraalVM](https://quarkus.io/guides/building-native-image)
-* On MAC, check [Setup MAC for Native image build](./Develop_on_Mac.md) for
further instructions.
+* On macOS, check [Developing on macOS](./docs/DEVELOP_ON_MACOS.md) for
further instructions.
-Docker is not strictly necessary, but it is a required to run some of the
integration tests.
-These tests can be skipped (see the [Build](#build) section), but we recommend
to install it to run these tests locally.
+Docker is not strictly necessary, but it is required to run some of the
integration tests.
+These tests can be skipped, but we recommend to install it to run these tests
locally.
* Check [the installation guide](https://docs.docker.com/install/), and [the
MacOS installation guide](https://docs.docker.com/docker-for-mac/install/)
-* If you just install docker, be sure that your current user can run a
container (no root required).
+* If you just install docker, be sure that your current user can run a
container (no root required).
On Linux, check [the post-installation
guide](https://docs.docker.com/install/linux/linux-postinstall/)
-
## Build
-* Clone the repository, navigate to the directory, invoke `./mvnw clean
install -Dquickly` from the root directory.
+Clone the repository, navigate to the directory, and build with the Maven
wrapper:
```bash
-git clone https://github.com/kiegroup/kogito-runtimes.git
-cd kogito-runtimes
-./mvnw clean install -Dquickly
+git clone https://github.com/apache/incubator-kie-drools.git
+cd incubator-kie-drools
Review Comment:
```suggestion
cd incubator-kie
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
