Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -42,37 +42,15 @@
42	42	(% style="text-align: justify;" %)
43	43	**(3)** The version branch should have the following **folders** & **files**:
44	44
45		-* **##schemas/##** (required) - contains the schemas of that metadata model implemented in the reduced openMINDS syntax (cf. below). The sub-directory of the "schemas" folder can be further structured or flat.
46		-* **##tests/##** (recommended) - contains test-instances (JSON-LDs) for checking the constraints defined in the schemas of the metadata model. The sub-directory of the "tests" folder should follow the same structure as the "schemas" folder. The file names of the test-instances should state in lowerCamelCase first the name of the respectively tested schema and second, separated with an underscore, what schema constrain is tested (e.g., **##contactInformation_validEmail.jsonld##**). If a test-instance is expected to fail the schema validation the file name should receive the postfix **##"_nok"##** (e.g., **##contactInformation_invalidEmail_nok.jsonld##**).
47		-* **##examples/##** (recommended)
	45	+* **##schemas/##** (required) - contains the schemas of the respective metadata model implemented in the reduced openMINDS syntax (cf. below). The sub-directory of the "schemas" folder can be further structured or flat.
	46	+* **##tests/##** (recommended) - contains test-instances (JSON-LDs) for checking the constraints defined in the schemas of the respective metadata model. The sub-directory of the "tests" folder should follow the same structure as the "schemas" folder with an additional sub-directory for each schema. The file names of the test-instances should be written in lowerCamelCase and state first the name of the respectively tested schema and second, separated with an underscore, what schema constrain is tested (e.g., **##contactInformation_validEmail.jsonld##**). If a test-instance is expected to fail the schema validation the file name should receive the postfix **##"_nok"##** (e.g., **##contactInformation_invalidEmail_nok.jsonld##**).
	47	+* **##examples/##** (recommended) - contains examples for valid instance collections for the respective metadata model. Each example should receive its own directory (folder) with a **##README.md##** describing the example, and an **##metadataCollection##** subfolder containing the openMINDS instances (JSON-LDs). This subfolder can be further structured or flat.
48	48	* **##img/##** (optional) - contains typically the logo of the openMINDS submodule.
49		-* **##instances/##** (optional) - contains the controlled metadata instances (JSON-LDs) for selected schemas of the metadata model. The sub-directory of the "instances" folder should follow the same structure as the "schemas" folder.
50		-* **##version.txt##** (required)
51		-* **##README.md##** (required)
52		-* **##LICENSE.txt##** (required)
	49	+* **##instances/##** (optional) - contains the controlled metadata instances (JSON-LDs) for selected schemas of the respective metadata model. The sub-directory of the "instances" folder should follow the same structure as the "schemas" folder with an additional sub-directory for each schema. The file names of the controlled instances should be written in lowerCamelCase and state the simple, human-readable identifier of the instance (e.g., **##homoSapiens.jsonld##** for the controlledTerms schema **##Species##**).
	50	+* **##version.txt##** (required) - states the identifier of the version branch (e.g., **##v1##**) of the respective metadata model.
	51	+* **##README.md##** (required) - contains a short content description of the respective metadata model.
	52	+* **##LICENSE.txt##** (required) - states the license for the respective metadata model (has to be MIT).
53	53
54		-
55		-(% style="text-align: justify;" %)
56		-**(5)** The **##tests##** folder should for the schemas in a flat directory. The file names for these test-instances should follow the convention of
57		-
58		-(% style="text-align: center;" %)
59		-**##<<XXX>>-<<YYY>>.jsonld##**
60		-
61		-(% style="text-align: justify;" %)
62		-for files that should pass the tests, and
63		-
64		-(% style="text-align: center;" %)
65		-**##<<XXX>>-<<YYY>>-nok.jsonld##**
66		-
67		-(% style="text-align: justify;" %)
68		-for files that should fail the test. In both cases, **##<<XXX>>##** should be replaced with the label of the schema that is tested, and **##<<YYY>>##** with a user defined label for what aspect is tested (e.g., **##person-withoutCI.jsonld##**).
69		-
70		-(% style="text-align: justify;" %)
71		-**(6)** The **##examples##** folder should contain examples for valid instance collections for that metadata model. Each example should receive its own directory (folder) with a **##README.md##** describing the example, and an **##metadataCollection##** subfolder containing the openMINDS instances (JSON-LDs). This subfolder can be further structured or flat.
72		-
73		-(% style="text-align: justify;" %)
74		-**(7)** The **##img##** folder should contain image files used on that GitHub repository (e.g., the logo of the new openMINDS metadata model). The directory of the images can be further structured or flat.
75		-
76	76	=== The openMINDS vocabulary ===
77	77
78	78	(% style="text-align: justify;" %)