Skip to content

Commit 3dd9645

Browse files
authored
📝 Fixed non-descriptive link texts (#564)
* 📝 Fixed non-descriptive link texts * 📝 Updated link text
1 parent 6867f1d commit 3dd9645

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/templates/develop.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Code Rabbit is free to use for open-source projects. If you are developing a pro
253253

254254
### CodeQL
255255

256-
**CodeQL** is a GitHub tool for discovering vulnerabilities and code smells in code. More details can be found [here](https://codeql.github.com/).
256+
**CodeQL** is a GitHub tool for discovering vulnerabilities and code smells in code. More details can be found on the [official CodeQL website](https://codeql.github.com/).
257257

258258
The template enables CodeQL for Pull Requests and configures CodeQL to only scan for Java and JavaScript/TypeScript/Vue files by default.
259259
For further information on how to change the configuration, please check out the documentation of the related custom [GitHub workflow](https://github.com/it-at-m/.github/blob/main/workflow-templates/codeql.yaml).
@@ -292,7 +292,7 @@ More information about Rulesets can be found in the [official GitHub documentati
292292

293293
::: danger IMPORTANT
294294
Note that the tools mentioned above (CodeRabbit, CodeQL, Dependency Review) are optional by default and are not required to pass when a PR should be merged.
295-
We strongly encourage you to enable the status checks for those tools before being able to merge a PR. More information about status checks can be found [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
295+
We strongly encourage you to enable the status checks for those tools before being able to merge a PR. More information about status checks can be found in the [official GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
296296
Status checks are configurable as part of the rulesets.
297297
:::
298298

docs/templates/organize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Additionally, labels indicate the priority of issues, for example, `Medium`.
1515
There are also labels that specify the type of issue, like `Documentation`.
1616

1717
We highly recommend using labels to maintain a clear structure.
18-
You can view all our current labels [here](https://github.com/it-at-m/refarch-templates/labels) for inspiration.
18+
You can view all our current labels on the [GitHub repository's label page](https://github.com/it-at-m/refarch-templates/labels) for inspiration.
1919
For more information on how to set up labels for your own project, please check the official [GitHub documentation](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels).
2020

2121
Your project labels are also utilized for [Automatic Labeling](#automatic-labeling).

docs/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The tools itself are described in [Develop](./templates/develop).
88
## PMD
99

1010
The `refarch-pmd` Java module provides a default ruleset for [PMD](https://pmd.github.io/) which is used for code linting.
11-
The module code can be found [here](https://github.com/it-at-m/refarch/tree/main/refarch-tools/refarch-java-tools/refarch-pmd) and the specific ruleset configuration [here](https://github.com/it-at-m/refarch/blob/main/refarch-tools/refarch-java-tools/refarch-pmd/src/main/resources/refarch-pmd-ruleset.xml).
11+
The module code can be found in the [`refarch-pmd` directory](https://github.com/it-at-m/refarch/tree/main/refarch-tools/refarch-java-tools/refarch-pmd) and the specific ruleset configuration inside the [`resources` subdirectory](https://github.com/it-at-m/refarch/blob/main/refarch-tools/refarch-java-tools/refarch-pmd/src/main/resources/refarch-pmd-ruleset.xml).
1212

1313
All available rules can be found in [the according PMD documentation](https://docs.pmd-code.org/latest/pmd_rules_java.html).
1414

0 commit comments

Comments
 (0)