Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
hmaier-fws committed Dec 20, 2024
2 parents 6cdc2f7 + 1596b82 commit d8a238c
Show file tree
Hide file tree
Showing 10 changed files with 203 additions and 91 deletions.
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# mdJSON Schema Style Guidelines
The following guidelines should be used when editiing mdJSON schema definition files.

# Guidelines
- [Use lowerCamelCase](#use-lowercamelcase)
- [Use singular tense](#use-singular-tense)
- [Provide all translations](#provide-all-translations)

## Use lowerCamelCase
Use lower camel case for all schema property names.

yes:
```
title
associatedResource{}
pointOfContact[]
```

no:
```
Title
AssociatedResource{}
pointofContact[]
```

## Use singular tense
Use singular tense for all property names names.

yes: `dataDictionary[]`

no: `dataDictionaries[]`

## Provide all translations
Provide translations for: 1) "[__FGDC CSDGM__](https://www.fgdc.gov/metadata/csdgm-standard)", 2) "__DCAT__" ([Data Catalog Vocabulary](https://www.w3.org/TR/vocab-dcat-2/)), and 3) "[__sbJSON__]" ([ScienceBase JSON](https://www.usgs.gov/sciencebase-instructions-and-documentation/item-core-model)) when an ISO translation is provided. If no translation is available indicate ```"no translation"```.

yes:
```
"translation": {
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"],
"FGDC CSDGM": ["no translation"]
"DCAT": ["no translation"],
"sbJSON": ["no translation"]
}
```

yes:
```
"translation": {
"ISO 19115-2": ["MD_Keywords > thesaurusName > CI_Citation"],
"FGDC CSDGM": [
"idinfo>keywords>theme>themekt",
"idinfo>keywords>place>placekt",
"idinfo>keywords>temporal>tempkt"
],
"DCAT": ["no translation"],
"sbJSON": ["tags > scheme"]
}
```

no:
```
"translation": {
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"]
}
```

no:
```
"translation": {
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"],
"FGDC CSDGM": ["no translation"]
}
```


8 changes: 4 additions & 4 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
PATH
remote: .
specs:
adiwg-mdjson_schemas (2.10.0)
adiwg-mdjson_schemas (2.10.1)

GEM
remote: https://rubygems.org/
specs:
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
adiwg-mdcodes (2.10.0)
adiwg-mdcodes (2.10.1)
json (~> 2.0)
json (2.7.2)
json (2.9.1)
json-schema (2.8.1)
addressable (>= 2.4)
minitest (5.22.2)
Expand All @@ -21,7 +21,7 @@ PLATFORMS
arm64-darwin-22

DEPENDENCIES
adiwg-mdcodes (= 2.10.0)
adiwg-mdcodes (= 2.10.1)
adiwg-mdjson_schemas!
bundler (~> 2)
json-schema (~> 2.8.1)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ as a workaround you can pre-load all of the schemas by calling `ADIWG::MdjsonSch
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

### Ignore anything below this line
### See [CONTRIBUTING](CONTRIBUTING.md) file

Just making changes to make changes to something. Trying to resolve merge conflicts.
View the [CONTRIBUTING.md](CONTRIBUTING.md) file for additional guidelines related to developing mdJson schemas.
2 changes: 1 addition & 1 deletion adiwg-json_schemas.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
spec.add_development_dependency "rake", ">= 0"
spec.add_development_dependency "json-schema", "~> 2.8.1"
spec.add_development_dependency "minitest", "~>5"
spec.add_development_dependency "adiwg-mdcodes", "2.10.0"
spec.add_development_dependency "adiwg-mdcodes", "2.10.1"
end
2 changes: 1 addition & 1 deletion lib/adiwg/mdjson_schemas/version.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module ADIWG
module MdjsonSchemas
# Current schema version number
VERSION = "2.10.0"
VERSION = "2.10.1"
end
end
Loading

0 comments on commit d8a238c

Please sign in to comment.