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
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ In order to start this task, run (we suggest using `--console=plain` to reduce a
30
30
./gradlew contribute --console=plain
31
31
```
32
32
33
-
When started, the task will ask you few simple questions (like: where are your tests implemented, do your tests need resources, do your tests need docker images...).
33
+
When started, the task will ask you few simple questions (like: where are your tests implemented, do your tests need resources, do your tests need docker images...).
34
34
In case you don't understand the question, just type "help".
35
35
36
36
After it collects your answers, the task will:
@@ -43,7 +43,7 @@ After it collects your answers, the task will:
43
43
In order to ensure that all contributions follow the same standards of quality we have devised a following list of requirements for each new added library.
44
44
`org.example:library` project is also included as a template for new libraries.
45
45
46
-
* GraalVM Reachability Metadata in this repo only contains JSON files as described
46
+
* GraalVM Reachability Metadata in this repo only contains JSON files as described
47
47
in [Manual Configuration](https://www.graalvm.org/latest/reference-manual/native-image/dynamic-features/Reflection/#manual-configuration)
48
48
section of the Native Image documentation.
49
49
* All other library tweaks (such as build time initialization through `native-image.properties`) must not be included
@@ -92,7 +92,7 @@ Every metadata has an entry in the `metadata/index.json`. For example:
92
92
"module": "org.example:dependant-library",
93
93
"requires": [
94
94
"org.example:library"
95
-
],
95
+
],
96
96
"allowed-packages": [
97
97
"org.package.name"
98
98
]
@@ -179,8 +179,8 @@ output if necessary:
179
179
180
180
## Tests
181
181
182
-
> **Note:** Contributors must be original authors of all the tests provided in the pull request, or
183
-
must add a comment that proves they may publish them under the license specified in those tests.
182
+
> **Note:** Contributors must be original authors of all the tests provided in the pull request, or
183
+
must add a comment that proves they may publish them under the license specified in those tests.
184
184
185
185
Every submitted library must feature tests that serve as a safeguard against regressions.
186
186
For easier test development we've provided a TCK plugin that automatically configures
@@ -236,7 +236,7 @@ The test code lives in `test-project-path`. In this example that would be `tests
236
236
"-Plibrary.version=<version>"
237
237
]
238
238
}
239
-
```
239
+
```
240
240
241
241
Supported template parameters for `test-command` are:
242
242
@@ -254,9 +254,9 @@ In this example this can be done by invoking following command from the reposito
254
254
```bash
255
255
./gradlew test -Pcoordinates=org.example:library:0.0.1
256
256
```
257
-
257
+
258
258
### Providing the tests that use docker
259
-
259
+
260
260
If your tests use Docker (either with explicit Docker process invocation or through some library method call), all images have to be declared in `required-docker-images` file.
261
261
This file must be placed under `/tests/src/<groupId>/<artifactId>/<versionId>`.
262
262
@@ -276,7 +276,7 @@ Possible scenarios:
276
276
* If your test uses Docker image that is not listed in [allowed docker images list](https://github.com/oracle/graalvm-reachability-metadata/blob/master/tests/tck-build-logic/src/main/resources/AllowedDockerImages.txt),
277
277
the test will fail
278
278
* Only docker images that are in both `required-docker-images.txt` and in the `allowed docker images list`
279
-
can be executed.
279
+
can be executed.
280
280
281
281
**Note:** For images that comes from Oracle, please consider using them from the official [Oracle Container Registry](https://container-registry.oracle.com).
282
282
See an [example](https://github.com/oracle/graalvm-reachability-metadata/blob/master/tests/tck-build-logic/src/main/resources/allowed-docker-images/Dockerfile-mysql_mysql-server).
@@ -302,8 +302,8 @@ Write an entry as follows:
302
302
}
303
303
```
304
304
Where:
305
-
*`<groupId>` and `<artifactId>` - part of the standard Maven coordinates ([see this](https://maven.apache.org/pom.html#maven-coordinates))
306
-
*`<artifactDescription>` - short description of the library or framework (_not required_)
305
+
*`<groupId>` and `<artifactId>` - part of the standard Maven coordinates ([see this](https://maven.apache.org/pom.html#Maven_Coordinates))
306
+
*`<artifactDescription>` - short description of the library or framework (_not required_)
307
307
*`<minimumVersion>` - minimal version for which this entry applies
308
308
*`<maximumVersion>` - maximal version for which this entry applies (_not required_)
309
309
*`<metadataLocations>` - list of web URLs providing metadata
Copy file name to clipboardExpand all lines: tests/tck-build-logic/src/main/resources/contributing/questions.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
[
2
2
{
3
3
"question-key": "coordinates",
4
-
"question": "What library do you want to support? Maven coordinates:",
4
+
"question": "What library do you want to support? Maven coordinates (i.e., \"groupId:artifactId:version\"):",
5
5
"help": "Maven coordinates consist of three parts in the following format \"groupId:artifactId:version\". For more information visit: https://maven.apache.org/repositories/artifacts.html"
0 commit comments