Skip to content

Commit 9ea93d1

Browse files
committed
Use descriptive link names in Markdown files to make MegaLinter happy
1 parent 56c3da8 commit 9ea93d1

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Contributing
22

33
Contributions are very much welcome! This can be in form of pull requests, issues, providing opinions on existing issues
4-
or pull request reviews. Moreover, let us know if you have a nice project that can be added to the list of
4+
or pull request reviews. Moreover, let us know if you have a nice project that can be added to the list of
55
[integrators](https://github.com/AuthMe/ConfigMe/wiki/Integrators)—seeing ConfigMe "out in the wild" helps understand
66
the needs and the pain points of users!
77

8-
ConfigMe is managed heavily based on GitHub issues, so you're invited to open a new issue also for questions
8+
ConfigMe is managed heavily based on GitHub issues, so you're invited to open a new issue also for questions
99
(like [#126](https://github.com/AuthMe/ConfigMe/issues/126)) or for any other discussion points. Please discuss larger
1010
code changes first, either by creating an issue or by writing in the [`#configme` channel](https://discord.com/channels/295623711485198357/1143605240520769547)
1111
of the AuthMe Discord server.
1212

1313
## General conventions
1414

15-
- If you're using IntelliJ, please install the Checkstyle plugin and configure it to use the rules from
15+
- If you're using IntelliJ, please install the Checkstyle plugin and configure it to use the rules from
1616
`.checkstyle.xml`, located in the project's root directory.
1717
- Commit messages ideally start with the issue number they relate to, e.g. `#229 Remove option to split map keys by "."`
1818
- Please use sensibly-sized commits (e.g. don't commit every change separately).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ public class WelcomeWriter {
7878
```
7979
:pencil: Read the full documentation in the [ConfigMe Wiki](https://github.com/AuthMe/ConfigMe/wiki).
8080

81-
:pencil: See a full working example based on this
82-
[here](https://github.com/AuthMe/ConfigMe/tree/master/src/test/java/ch/jalu/configme/demo).
81+
:pencil: See a full working example based on this:
82+
[ConfigMe demo](https://github.com/AuthMe/ConfigMe/tree/master/src/test/java/ch/jalu/configme/demo).
8383

8484
:pencil: See how to use custom classes as property types in the
8585
[bean properties demo](https://github.com/AuthMe/ConfigMe/tree/master/src/test/java/ch/jalu/configme/demo/beans).

src/test/java/ch/jalu/configme/demo/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# ConfigMe demo
22

33
This folder contains a small demonstration showing how ConfigMe can be used.
4-
You can find the config.yml file [here](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/config.yml).
4+
The configuration file with the values is here:
5+
[config.yml](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/config.yml).
56

67
TitleConfig contains some `Property` fields which represent the properties in the config.yml file.
78
These sample properties are then used in `WelcomeWriter` in order to generate a short text with

src/test/java/ch/jalu/configme/demo/beans/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ they have and will then use the config.yml file to create new objects with the d
66
config.yml. `BeanPropertiesDemo` creates a settings manager and uses it to get the
77
`DemoSettings.USER_BASE` setting.
88

9-
You can find the config YAML file [here](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/bean_demo_config.yml).
9+
The config YAML file is here:
10+
[bean_demo_config.yml](https://github.com/AuthMe/ConfigMe/blob/master/src/test/resources/demo/bean_demo_config.yml).
1011
Detailed information about using beans as properties can be found on the
1112
[Bean properties page](https://github.com/AuthMe/ConfigMe/wiki/Bean-properties) of the Wiki.

0 commit comments

Comments
 (0)