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

Update README.md #3

Merged
merged 3 commits into from
Oct 17, 2024
Merged

Update README.md #3

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bb061a
Update README.md
adf-ncgr Oct 16, 2024
84d47c2
Update README.md
adf-ncgr Oct 17, 2024
c77e01d
Update README.md
adf-ncgr Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# datastore-metadata
All the LIS Datastore YAML files under one roof.

This repository contains the description_[Genus]_[species].yml and README.[collection].yml files in the LIS Datastore.
All the LIS Datastore YAML files (and some others we consider "metadata") under one roof.

This repository contains the description_[Genus]_[species].yml and README.[collection].yml files in the LIS Datastore.
For each collection, it also contains the CHECKSUM.[collection].md5 files (mainly because these can be used as a list of the files in the collection); these should be generated with the script [mdsum-folder.bash](https://github.com/legumeinfo/datastore-specifications/blob/main/scripts/mdsum-folder.bash)
After creating a new collection in the datastore (or making changes to the contents of an existing collection, which should be followed by an update to the CHECKSUM.[collection].md5), please be sure to:
```
git add README.[collection].yml CHECKSUM.[collection].md5
git commit (with some informative log message)
git push
```
All other files are blocked from being added to the repository in .gitignore -- except files that probably shouldn't belong in the Datastore to begin with.
Having these files up-to-date in the github repo is important not only for version control purposes, but also because some of our tools operate by cloning this repo and using the metadata as a light-weight representation of the state of the datastore. Some files (e.g. BUSCO summary files) have also been introduced into this repository to facilitate consumption by applications from a cloned version of the repository.

GitHub Actions will now validate your file(s) upon commit and will fail if they don't pass validation.
Loading