Skip to content

Commit

Permalink
update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robberphex committed Feb 22, 2024
1 parent ae6ebb4 commit d929b4b
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,18 @@ Please make sure to read and observe our [Code of Conduct](./CODE_OF_CONDUCT.md)

### Setting up your development environment

You should have JDK 1.8 or later installed in your system.
You should have JDK 17 or later installed in your system.

### How to run test

1. add `~/.m2/toolchains.xml`, to define JDK and path. See [toolcahinas-example.xml](./toolcahinas-example.xml).
2. With JDK 17 as your default JDK, you could specify the JDK version to run test,

i.e. Run test at JDK 8:

```bash
mvn test -Dsurefire.jdk-toolchain-version=8
```

## Contributing

Expand Down
48 changes: 48 additions & 0 deletions toolchains-example.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?xml version="1.0"?>
<toolchains xmlns="http://maven.apache.org/TOOLCHAINS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/TOOLCHAINS/1.1.0 http://maven.apache.org/xsd/toolchains-1.1.0.xsd">
<toolchain>
<type>jdk</type>
<provides>
<version>8</version>
<vendor>temurin</vendor>
<id>temurin_8</id>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/temurin-8.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
<toolchain>
<type>jdk</type>
<provides>
<version>11</version>
<vendor>temurin</vendor>
<id>temurin_11</id>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/temurin-11.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
<toolchain>
<type>jdk</type>
<provides>
<version>17</version>
<vendor>temurin</vendor>
<id>temurin_17</id>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
<toolchain>
<type>jdk</type>
<provides>
<version>21</version>
<vendor>temurin</vendor>
<id>temurin_21</id>
</provides>
<configuration>
<jdkHome>/Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home</jdkHome>
</configuration>
</toolchain>
</toolchains>

0 comments on commit d929b4b

Please sign in to comment.