Skip to content

Commit

Permalink
Polish CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
izeye authored and vjovanov committed Feb 22, 2023
1 parent d65f9a8 commit 1ed573c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ In order to ensure that all contributions follow the same standards of quality w
> ℹ️ **Note** :
>
> GraalVM Reachability Metadata in this repo only contains JSON files as described
> in [Manual Configuration](https://www.graalvm.org/22.0/reference-manual/native-image/Reflection/#manual-configuration)
> in [Manual Configuration](https://www.graalvm.org/latest/reference-manual/native-image/dynamic-features/Reflection/#manual-configuration)
> section of the Native Image documentation.
>
> All other library tweaks (such as build time initialization through `native-image.properties`) must not be included
> here. By default, it should be assumed that all user libraries are runtime initialized. Build-time initialization can
> not be included as it does not compose and can break code in unpredictable ways.
>
> Make sure that you are
> using [Conditional Configuration](https://www.graalvm.org/22.2/reference-manual/native-image/metadata/#specifying-reflection-metadata-in-json)
> using [Conditional Configuration](https://www.graalvm.org/latest/reference-manual/native-image/metadata/#specifying-reflection-metadata-in-json)
> in order to precisely define the metadata scope. This is a hard requirement as it prevents unnecessary bloating of
> images.
>
Expand Down Expand Up @@ -100,7 +100,7 @@ The `override` flag allows to express the intent to exclude outdated builtin met
So, the metadata for `org.example:library:0.0.1` and `org.example:library:0.0.2` is located
at `metadata/org.example/library/0.0.1`.

Make sure that each supported version is listed in `tested-version`, as that value is used in build tools to match
Make sure that each supported version is listed in `tested-versions`, as that value is used in build tools to match
metadata to a specific library.
Every metadata for a specific library version has a `index.json`. For this
example `metadata/org.example/library/0.0.1/index.json` would contain:
Expand Down Expand Up @@ -183,8 +183,8 @@ The test code lives in `test-project-path`. In this example that would be `tests
Supported template parameters for `test-command` are:

* `<metadata_dir>` - absolute path to directory where metadata is stored
* `<group_id>` - Maven groupID of artifact that is being tested
* `<artifact_id>`- Maven artifactID of artifact that is being tested
* `<group_id>` - Maven group ID of artifact that is being tested
* `<artifact_id>`- Maven artifact ID of artifact that is being tested
* `<version>` - Version of artifact that is being tested

**Note that if `index.json` is omitted `gradle nativeTest` is executed by default.**
Expand Down Expand Up @@ -230,5 +230,5 @@ Where:
* fully-tested (the library is fully tested for each released library version)

**Note:** To pass format and style checks, please run `sorted="$(jq -s '.[] | sort_by(.artifact)' library-and-framework-list.json)" && echo -E "${sorted}" > library-and-framework-list.json` before submitting a PR.
**Note:** The entries you add will be validated against [library-and-framework-list-schema.json](https://github.com/oracle/graalvm-reachability-metadata/blob/master/library-and-framework-list-schema.json)

**Note:** The entries you add will be validated against [library-and-framework-list-schema.json](https://github.com/oracle/graalvm-reachability-metadata/blob/master/library-and-framework-list-schema.json)

0 comments on commit 1ed573c

Please sign in to comment.