Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use consistent formatting of metadata field names #31

Open
alanorth opened this issue Jan 18, 2021 · 3 comments · May be fixed by #34
Open

Use consistent formatting of metadata field names #31

alanorth opened this issue Jan 18, 2021 · 3 comments · May be fixed by #34
Labels
question Further information is requested
Milestone
CG Core v2.1

Comments

@alanorth
Copy link
Collaborator

The DCTERMS schema makes use of "camel case" for metadata field names that contain multiple words, for example bibliographicCitation and accessRights. I know it's a bit arbitrary and doesn't actually matter, but we already do this for some of our own fields and we should at least be consistent.

I propose that we adjust the following fields in CG Core v2 to follow the convention:

  • cg.peer-reviewed → cg.peerReviewed
  • cg.howpublished → cg.howPublished
  • cg.booktitle → cg.bookTitle

I think that's all of them...
@alanorth alanorth added the question Further information is requested label Jan 18, 2021
@marieALaporte
Copy link
Member

that's a good point, thanks.
Since we are going to need a new minor version of the schema (2.1 or something), we can add all minor changes at that time

@alanorth alanorth added this to the CG Core v2.1 milestone Jan 18, 2021
@alanorth
Copy link
Collaborator Author

OK that is great. So we move this to CG Core v2.1. I will create a GitHub "milestone" for that and tag it here.

BTW I added a CHANGELOG.md and we can add this type of thing there as well. Much easier to see major changes that way instead of looking in issues and git commit history.

alanorth added a commit to alanorth/cgspace-notes that referenced this issue Jan 18, 2021
@alanorth
content/posts/cgspace-cgcorev2-migration.md: Update
c6cc878 
We agreed to use "camel case" convention for multi-word field names.

See: AgriculturalSemantics/cg-core#31
@marieALaporte
Copy link
Member

cg.HasMetadata -> cg.hasMetadata

@marieALaporte marieALaporte mentioned this issue Jan 19, 2021
Open
@alanorth alanorth linked a pull request Jan 19, 2021 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question Further information is requested
Projects
None yet
Milestone
CG Core v2.1
Development

Successfully merging a pull request may close this issue.

Use consistent "camel case" for field names alanorth/cg-core
2 participants
@alanorth @marieALaporte