You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,25 @@ To send us a pull request, please:
36
36
5. Send us a pull request, answering any default questions in the pull request interface.
37
37
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
38
39
+
40
+
## Build Prerequisites
41
+
42
+
This project uses the Maven Toolchains Plugin to pin compilation to JDK 8. If you don't have a `~/.m2/toolchains.xml` configured, builds will fail with:
43
+
44
+
```
45
+
No toolchain found for type jdk [ version='[1.8,9)' ]
46
+
```
47
+
48
+
To fix this, copy the example file to your Maven config directory and update the path:
49
+
50
+
```bash
51
+
cp toolchains.xml.example ~/.m2/toolchains.xml
52
+
```
53
+
54
+
Then edit `~/.m2/toolchains.xml` and set `<jdkHome>` to your local JDK 8 installation path.
55
+
56
+
Note: if you use `actions/setup-java` in CI (as our GitHub Actions workflows do), this file is generated automatically.
57
+
39
58
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
59
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
0 commit comments