You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Changes were reviewed and confirmed by two people |☐|☐|
14
-
| Changes are covered by unit tests |☐|☐|
15
-
| Entry was added to CHANGELOG |☐|☐|
16
-
| Documentation was added or adjusted |☐|☐|
17
-
| CI build passes |☐|☐|
18
-
||☐|☐|
19
-
| Build is successful and tests pass when running `mvn test` (or even better `mvn clean test`) | - []| - []|
20
-
| PR title is of the form `#«issue-id»: «brief summary»` (e.g. `#921: fixed setup.bat`) |☐|☐|
21
-
| PR top-level comment summarizes what has been done and contains link to addressed issue(s) |☐|☐|
22
-
| PR is linked with the issue(s) that it implements and resolves (see sidebar, click on *Development* and enter issue ID) - to achieve this add `fixes #«issue-id»` to your PR summary. |☐|☐|
23
-
| PR and issue(s) have suitable labels (OS-specific like `windows`, `macOS`, or `linux` as well as other aspects like `commandlet`, `plugins`, `urls`, or tool specific labels such as `eclipse` or `java`) |☐|☐|
24
-
| Issue is set to `In Progress` and assigned to you (should actually be done before you start your implementation). See also [here](https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-contribution-rules-and-guidelines.adoc). |☐|☐|
25
-
| Milestones are typically assigned by PO (Jörg) but have to be set before issues and PRs get closed. In case your issue is only addressed by a change in 'ide-mirrors/ide-urls or in ide-settings` repository, please already assign the according milestone. |☐|☐|
26
-
| All GitHub checks have passed. Otherwise, if a check failed (red cross) you need to click the *Details* link, read the logs and fix the problem.<ul><li>The build and all automated tests succeeded. If failed, and you clicked on Details add read the logs to find the error.</li><li> The contributors license agreement (CLA) is signed by all contributors of the PR.</li><li>Git-Guardian did not report any security issue</li></ul> |☐|☐|
27
-
| The feature branch of the PR is up-to-date with the `main` branch.<br/><br/>If you see `This branch is out-of-date with the base branch` in the PR click the `Update branch` button to fix (or manually merge with the main from upstream locally and push your changes). In case you see `This branch has conflicts that must be resolved` instead, you need to resolve conflicts. Very simple conflicts may be resolved in the browser on GitHub. But as a general recommendation you should resolve the conflicts locally with proper merge tool support and rerun tests before you push the merged changes. |☐|☐|
28
-
| You followed all link:coding-conventions.adoc[coding conventions]|☐|☐|
29
-
| You have already added the issue implemented by your PR in <ahref="https://github.com/devonfw/IDEasy/blob/main/CHANGELOG.adoc">CHANGELOG.adoc</a> to the next open release (see milestones or <ahref="https://github.com/devonfw/IDEasy/blob/main/.mvn/maven.config">maven.config</a>).<br><ul><li>If there is no issue for your PR consider creating it or directly link the PR itself.</li><li>Please note that the CHANGELOG shall only reflect public changes relevant for end-users.<br>So e.g. if we implement a story and then add another PR as bugfix or improvement to the same story before the bug was ever released, we do not need to document this in the CHANGELOG to avoid spam and confusion.</li></ul> |☐|☐|
30
-
| In case your PR adds a new tool `«tool»` as commandlet there are the following additional checks: |☐|☐|
31
-
||☐|☐|
9
+
Make sure everything is checked before merging this PR. For further info please also see
-[ ] Build is successful and tests pass when running `mvn test`
13
+
-[ ] PR title is of the form `#«issue-id»: «brief summary»` (e.g. `#921: fixed setup.bat`). If no issue ID exists, title only.
14
+
-[ ] PR top-level comment summarizes what has been done and contains link to addressed issue(s)
15
+
-[ ] PR and issue(s) have suitable labels
16
+
-[ ] Issue is set to `In Progress` and assigned to you *or* there is no issue (might happen for very small PRs)
17
+
-[ ] At least one milestone is assigned (typically done by PO)
18
+
-[ ] The feature branch of the PR is up-to-date with the `main` branch
19
+
-[ ] You followed all [coding conventions](link:coding-conventions.adoc)
20
+
-[ ] You have added the issue implemented by your PR in [CHANGELOG.adoc](https://github.com/devonfw/IDEasy/blob/main/CHANGELOG.adoc)
21
+
22
+
Have you added a new `«tool»` as commandlet? The following points need to be checked off, too:
23
+
24
+
<details>
25
+
<summary>Checklist for tool commandlets</summary>
26
+
-[ ] A new urlUpdater named `«tool»` has been added to a folder in [updater](https://github.com/devonfw/ide/tree/master/url-updater/src/main/java/com/devonfw/tools/ide/url/updater)
27
+
-[ ] A new commandlet named `«tool»` has been added to [command](https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/command)
28
+
-[ ] The tool can be installed automatically (during setup via settings) or via the commandlet call
29
+
-[ ] The tool will be installed locally to the software folder inside the IDEasy installation (${IDEASY_HOME}) *or* it is an exception to this rule
30
+
-[ ] The tool can be configured via files that are placed inside the IDEasy installation (${IDEASY_HOME}) *or* it is an exception to this rule
31
+
-[ ] The new commandlet is documented as `«tool»`.asciidoc in the [documentation](https://github.com/devonfw/ide/tree/master/documentation) folder
32
+
-[ ] The new commandlet is added and linked in [cli.asciidoc](https://github.com/devonfw/ide/blob/master/documentation/cli.asciidoc#commandlet-overview)
33
+
-[ ] The new commandlet is added and linked in [scripts.asciidoc](https://github.com/devonfw/ide/blob/master/documentation/scripts.asciidoc)
34
+
-[ ] The new commandlet is included to [devonfw-ide-usage.asciidoc](https://github.com/devonfw/ide/blob/master/documentation/devonfw-ide-usage.asciidoc)
35
+
-[ ] The new tool is added to the table of tools in [LICENSE.asciidoc](https://github.com/devonfw/ide/blob/master/documentation/LICENSE.asciidoc#license)
36
+
-[ ] The new commandlet is a [command-wrapper](https://github.com/devonfw/ide/blob/master/documentation/cli.asciidoc#command-wrapper) for `«tool»`
37
+
-[ ] The new commandlet installs potential dependencies automatically
38
+
-[ ] The new commandlet defines the variable `TOOL_VERSION_COMMAND` before sourcing the functions
39
+
-[ ] Calling `ide get-version «tool»", `ide list-versions «tool»" and `ide set-version «tool»" works *or* the tool does not provide any such setup
40
+
-[ ] The variable `«TOOL»_VERSION` is honored by your commandlet???
41
+
-[ ] The new commandlet is tested on all platforms it is available for or tested on all platforms that are in scope of the linked issue
42
+
</details>
43
+
44
+
Have you added, changed or deleted a *function* (in `functions` or `environment-project`)?
45
+
46
+
-[ ][functions.asciidoc](https://github.com/devonfw/ide/blob/master/documentation/functions.asciidoc) has been updated
0 commit comments