Skip to content

Commit 124d15d

Browse files
committed
Improve documentation
1 parent 52e67ff commit 124d15d

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In order to start this task, run (we suggest using `--console=plain` to reduce a
3030
./gradlew contribute --console=plain
3131
```
3232

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...).
3434
In case you don't understand the question, just type "help".
3535

3636
After it collects your answers, the task will:
@@ -43,7 +43,7 @@ After it collects your answers, the task will:
4343
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.
4444
`org.example:library` project is also included as a template for new libraries.
4545

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
4747
in [Manual Configuration](https://www.graalvm.org/latest/reference-manual/native-image/dynamic-features/Reflection/#manual-configuration)
4848
section of the Native Image documentation.
4949
* 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:
9292
"module": "org.example:dependant-library",
9393
"requires": [
9494
"org.example:library"
95-
],
95+
],
9696
"allowed-packages": [
9797
"org.package.name"
9898
]
@@ -179,8 +179,8 @@ output if necessary:
179179

180180
## Tests
181181

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.
184184

185185
Every submitted library must feature tests that serve as a safeguard against regressions.
186186
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
236236
"-Plibrary.version=<version>"
237237
]
238238
}
239-
```
239+
```
240240

241241
Supported template parameters for `test-command` are:
242242

@@ -254,9 +254,9 @@ In this example this can be done by invoking following command from the reposito
254254
```bash
255255
./gradlew test -Pcoordinates=org.example:library:0.0.1
256256
```
257-
257+
258258
### Providing the tests that use docker
259-
259+
260260
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.
261261
This file must be placed under `/tests/src/<groupId>/<artifactId>/<versionId>`.
262262

@@ -276,7 +276,7 @@ Possible scenarios:
276276
* 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),
277277
the test will fail
278278
* 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.
280280

281281
**Note:** For images that comes from Oracle, please consider using them from the official [Oracle Container Registry](https://container-registry.oracle.com).
282282
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:
302302
}
303303
```
304304
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_)
307307
* `<minimumVersion>` - minimal version for which this entry applies
308308
* `<maximumVersion>` - maximal version for which this entry applies (_not required_)
309309
* `<metadataLocations>` - list of web URLs providing metadata

tests/tck-build-logic/src/main/resources/contributing/questions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
{
33
"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\"):",
55
"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"
66
},
77
{

0 commit comments

Comments
 (0)