Skip to content

Commit b8da532

Browse files
authored
Update CONTRIBUTING.md
[skip ci] Signed-off-by: Ashley <73482956+ascopes@users.noreply.github.com>
1 parent c501080 commit b8da532

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ check the issues tab to see if anything is of interest.
1111
If you want further clarification, feel free to drop a
1212
comment.
1313

14-
You could alternatively add a message on the discussions
15-
tab!
14+
> [!TIP]
15+
> You could alternatively add a message on the discussions
16+
> tab!
1617
1718
Contributions do not necessarily need to be code changes
1819
either. You can also contribute by:
@@ -71,8 +72,9 @@ unnecessarily!
7172

7273
## Building this project
7374

74-
This project uses Apache Maven as the build system, and
75-
requires JDK 11 or newer.
75+
> [!IMPORTANT]
76+
> This project uses Apache Maven as the build system, and
77+
> requires JDK 11 or newer.
7678
7779
To build this project and run the tests, you can run the
7880
following in your terminal:
@@ -103,9 +105,11 @@ You can find out more about what this means at
103105
[TLDRLegal](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))!
104106

105107
Each file that you create must have a special header
106-
comment at the top that mentions this license. If you
107-
need to add this header to your files, you can run
108-
`./mvnw license:format` to do it for you automatically!
108+
comment at the top that mentions this license.
109+
110+
> [!TIP]
111+
> If you need to add this header to your files, you can run
112+
> `./mvnw license:format` to do it for you automatically!
109113
110114
## Code style
111115

@@ -125,8 +129,10 @@ Good things to remember:
125129
- Keep naming clear and simple!
126130

127131
A tool called CheckStyle will attempt to enforce these rules
128-
for you. You can run `./mvnw checkstyle:check` to verify
129-
your code matches these rules.
132+
for you.
133+
134+
> [!TIP]
135+
> You can run `./mvnw checkstyle:check` to verify your code matches these rules.
130136
131137
## Commits
132138

0 commit comments

Comments
 (0)