This is an automated email from the ASF dual-hosted git repository.
fjtiradosarti pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-kie-kogito-runtimes.git
The following commit(s) were added to refs/heads/main by this push:
new 4611a75896 Fix_#3443 Update template and contribution guides with
github issues (#3445)
4611a75896 is described below
commit 4611a75896a17a5e1a4d5904cd20b697ecaf9c90
Author: Gonzalo Muñoz <[email protected]>
AuthorDate: Mon Aug 5 13:14:10 2024 +0200
Fix_#3443 Update template and contribution guides with github issues (#3445)
---
.github/pull_request_template.md | 94 +++++-----------------------------------
CONTRIBUTING.md | 16 +++----
2 files changed, 18 insertions(+), 92 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 5cf14e83c6..a054658679 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -19,12 +19,20 @@
Many thanks for submitting your Pull Request :heart:!
+<!-- Please don't forget your Issue link -->
+Closes/Fixes/Resolves #ISSUE-NUMBER
+
+<!-- Please provide a short description of what this PR does -->
+**Description:**
+
+<!-- Link to related PRs: -->
+
Please make sure that your PR meets the following requirements:
- [ ] You have read the [contributors guide](CONTRIBUTING.md)
- [ ] Your code is properly formatted according to [this
configuration](https://github.com/apache/incubator-kie-kogito-runtimes/tree/main/kogito-build/kogito-ide-config)
-- [ ] Pull Request title is properly formatted: `KOGITO-XYZ Subject`
-- [ ] Pull Request title contains the target branch if not targeting main:
`[0.9.x] KOGITO-XYZ Subject`
+- [ ] Pull Request title is properly formatted: `Issue-XYZ Subject`
+- [ ] Pull Request title contains the target branch if not targeting main:
`[0.9.x] Issue-XYZ Subject`
- [ ] Pull Request contains link to the JIRA issue
- [ ] Pull Request contains link to any dependent or related Pull Request
- [ ] Pull Request contains description of the issue
@@ -40,86 +48,4 @@ Build Chain tool does "simple" maven build(s), the builds
are just Maven command
[build-chain tool](https://github.com/kiegroup/github-action-build-chain) is a
build tool which can be used on command line locally or in Github Actions
workflow(s), in case you need to change multiple repositories and send multiple
dependent pull requests related with a change you can easily reproduce the same
build by executing it on Github hosted environment or locally in your
development environment. See [local
execution](https://github.com/kiegroup/github-action-build-chain#local-ex [...]
</details>
-<details>
-<summary>
-How to retest this PR or trigger a specific build:
-</summary>
-
-- for <b>pull request checks</b>
- Please add comment: <b>Jenkins retest this</b>
-
-- for a <b>specific pull request check</b>
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] tests</b>
-
-- for <b>quarkus branch checks</b>
- Run checks against Quarkus current used branch
- Please add comment: <b>Jenkins run quarkus-branch</b>
-- for a <b>quarkus branch specific check</b>
- Run checks against Quarkus current used branch
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] quarkus-branch</b>
-
-- for <b>quarkus main checks</b>
- Run checks against Quarkus main branch
- Please add comment: <b>Jenkins run quarkus-main</b>
-
-- for a <b>specific quarkus main check</b>
- Run checks against Quarkus main branch
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] quarkus-main</b>
-
-- for <b>quarkus lts checks</b>
- Run checks against Quarkus lts branch
- Please add comment: <b>Jenkins run quarkus-lts</b>
-
-- for a <b>specific quarkus lts check</b>
- Run checks against Quarkus lts branch
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] quarkus-lts</b>
-
-- for <b>native checks</b>
- Run native checks
- Please add comment: <b>Jenkins run native</b>
-
-- for a <b>specific native check</b>
- Run native checks
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] native</b>
-
-- for <b>native lts checks</b>
- Run native checks against quarkus lts branch
- Please add comment: <b>Jenkins run native-lts</b>
-
-- for a <b>specific native lts check</b>
- Run native checks against quarkus lts branch
- Please add comment: <b>Jenkins (re)run
[kogito-runtimes|kogito-apps|kogito-examples] native-lts</b>
-</details>
-
-<details>
-<summary>
-How to backport a pull request to a different branch?
-</summary>
-
-In order to automatically create a **backporting pull request** please add one
or more labels having the following format `backport-<branch-name>`, where
`<branch-name>` is the name of the branch where the pull request must be
backported to (e.g., `backport-7.67.x` to backport the original PR to the
`7.67.x` branch).
-
-> **NOTE**: **backporting** is an action aiming to move a change (usually a
commit) from a branch (usually the main one) to another one, which is generally
referring to a still maintained release branch. Keeping it simple: it is about
to move a specific change or a set of them from one branch to another.
-
-Once the original pull request is successfully merged, the automated action
will create one backporting pull request per each label (with the previous
format) that has been added.
-
-If something goes wrong, the author will be notified and at this point a
manual backporting is needed.
-
-> **NOTE**: this automated backporting is triggered whenever a pull request on
`main` branch is labeled or closed, but both conditions must be satisfied to
get the new PR created.
-</details>
-
-<details>
-<summary>
-Quarkus-3 PR check is failing ... what to do ?
-</summary>
-The Quarkus 3 check is applying patches from the
`.ci/environments/quarkus-3/patches`.
-
-The first patch, called `0001_before_sh.patch`, is generated from Openrewrite
`.ci/environments/quarkus-3/quarkus3.yml` recipe. The patch is created to speed
up the check. But it may be that some changes in the PR broke this patch.
-No panic, there is an easy way to regenerate it. You just need to comment on
the PR:
-```
-jenkins rewrite quarkus-3
-```
-and it should, after some minutes (~20/30min) apply a commit on the PR with
the patch regenerated.
-
-Other patches were generated manually. If any of it fails, you will need to
manually update it... and push your changes.
-</details>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9c12041bf4..4746a07e1b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,7 +33,7 @@ modified, such other license.
## Issues
-Kogito uses [JIRA to manage and report
issues](https://issues.redhat.com/projects/KOGITO/).
+Kogito uses
[Issues](https://github.com/apache/incubator-kie-kogito-runtimes/issues).
If you believe you found a bug, please indicate a way to reproduce it, what
you are seeing and what you would expect to see. Don't forget to indicate your
Kogito, Java, Maven, Quarkus/Spring, GraalVM version.
@@ -50,18 +50,18 @@ If you are interested in having more details, refer to the
[Build section](#buil
To contribute, use GitHub Pull Requests, from your **own** fork.
-- PRs should be always related to an open JIRA issue. If there is none, you
should create one.
+- PRs should be always related to an open an
[issue](https://github.com/apache/incubator-kie-kogito-runtimes/issues). If
there is none, you should [create
one](https://github.com/apache/incubator-kie-kogito-runtimes/issues/new) by
describing what problem you see that we need to fix.
- Try to fix only one issue per PR.
-- Make sure to create a new branch. Usually branches are named after the JIRA
ticket they are addressing. E.g. for ticket "KOGITO-XYZ An example issue" your
branch should be at least prefixed with `KOGITO-XYZ`. E.g.:
+- Make sure to create a new branch. Usually branches are named after the
github issue they are addressing. E.g. for ticket "Fix_#issue An example
issue". E.g.:
- git checkout -b KOGITO-XYZ
+ git checkout -b Fix_#XYZ
# or
- git checkout -b KOGITO-XYZ-my-fix
+ git checkout -b Fix_#XYZ-my-fix
-- When you submit your PR, make sure to include the ticket ID, and its title;
e.g., "KOGITO-XYZ An example issue".
-- The description of your PR should describe the code you wrote. The issue
that is solved should be at least described properly in the corresponding JIRA
ticket.
+- When you submit your PR, make sure to include the ticket ID, and its title;
e.g., "Fix_#XYZ An example issue".
+- The description of your PR should describe the code you wrote. The issue
that is solved should be at least described properly in the corresponding
github issue.
- If your contribution spans across multiple repositories,
- use the same branch name (e.g. `KOGITO-XYZ`) in each PR so that our CI
(Jenkins) can build them all at once.
+ use the same branch name (e.g. `Fix_#XYZ`) in each PR so that our CI
(Jenkins) can build them all at once.
- If your contribution spans across multiple repositories, make sure to list
all the related PRs.
### Java Coding Guidelines
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
