Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#675: Fix typos in DoD asciidoc #679

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions documentation/DoD.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Otherwise if a check failed (red cross) you need to click the `Details` link, re
** [ ] The build and all automated tests succeeded.
If failed and you clicked on `Details` add read the logs to find the error.
** [ ] The contributors license agreement (CLA) is signed by all contributors of the PR.
** [ ] Git-Gardian did not report any security issue
** [ ] Git-Guardian did not report any security issue
* [ ] The feature branch of the PR is up-to-date with the `main` branch.
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 conficts may be resolved in the browser on github.
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.
* [ ] You followed all link:coding-conventions.adoc[coding conventions]
* [ ] You have already added the issue implemented by your PR in https://github.com/devonfw/ide/blob/master/CHANGELOG.adoc[CHANGELOG.adoc] to the next open release (see milestones or https://github.com/devonfw/IDEasy/blob/main/.mvn/maven.config[maven.config]).
Expand All @@ -41,11 +41,11 @@ There are very few tools as exception to this rule like `Docker` that extend `Gl
** [ ] The tool can be configured locally inside `$IDE_HOME/conf` and not from a global location (e.g. in `$HOME`).
Note: If a tool reads configuration files from the users home directory this is not given as two IDEasy projects using the same tool then would read the same config so one installation would influence the other.
** [ ] The help page displays information about the commandlet and its properties (CLI parameters) explaining how to use it properly.
There are no warnings logged in the help output (like `Cound not find key 'cmd-gcviewer' in ResourceBundle nls.Ide.properties`).
There are no warnings logged in the help output (like `Could not find key 'cmd-gcviewer' in ResourceBundle nls.Ide.properties`).
Therefore add proper help texts for all supported languages https://github.com/devonfw/IDEasy/tree/main/cli/src/main/resources/nls[here].
** [ ] The new tool is added to the table of tools in https://github.com/devonfw/ide/blob/master/documentation/LICENSE.asciidoc#license[LICENSE.asciidoc] with its according licesne.
** [ ] The new tool is added to the table of tools in https://github.com/devonfw/ide/blob/master/documentation/LICENSE.asciidoc#license[LICENSE.asciidoc] with its according license.
If that license is not yet included, the full license text needs to be added.
** [ ] The new commandlet installs potential dependencies automatically (e.g. `getCommandlet(«DependentTool».class).install()` in overridden `install` method).
** [ ] The variables `«TOOL»_VERSION` and `«TOOL»_EDITION` are honored by your commandlet so if present that edition and version will be downloaded and installed (happens by default but important if you implement custom installation logic).
** [ ] The new commandlet is tested on all plattforms it is availible for.
** [ ] The new commandlet is tested on all platforms it is available for.
Assuming you are using Windows, testing for Linux can be done with WSL or Virtual Box and for MacOS we have a virtual cloud instance.
Loading