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.

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

Create dataset review issue template #134

Merged
merged 2 commits into from
Nov 22, 2022
Merged

Create dataset review issue template #134

merged 2 commits into from
Nov 22, 2022

Conversation

7yl4r
Copy link
Contributor

@7yl4r 7yl4r commented Nov 18, 2022

We should encourage data managers to open issues here instead of emailing Abby about everything. Creating some issue templates might help make that seem more approachable. This PR creates a template for people wanting a second pair of eyes on their DwC alignment efforts.

You can test drive how this works on my fork: https://github.com/7yl4r/bio_data_guide/issues

Thanks to @sebastiandig for being a guinea pig and inspiring this idea.


This connects in with our ongoing "dataset management protocol" discussion, @MathewBiddle. Hopefully this insn't entirely in the wrong direction.


Additional thoughts:

should we have separate forms for:

  • completely raw data and I don't know how to start
  • take a look at my columns and confirm I have the right idea
  • final check before adding to IPT

Copy link
Contributor

@MathewBiddle MathewBiddle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put some comments/changes in. I think @albenson-usgs should take a look as well.

@MathewBiddle
Copy link
Contributor

@albenson-usgs this is what the form looks like. Are there other pieces you might need for the first review of a dataset?

image

@albenson-usgs
Copy link
Contributor

I think this has what I would need but it would be good to add a place for the metadata (Matt maybe we should link to the MBON metadata page once we have it final?). I also want to bring @sformel-usgs into this.

One thing I'm struggling with is that currently it feels to me like every time there is a dataset to review via GitHub and the bio_data_guide it's coming to me in different ways. I'm happy to use this form if this is the single method that people are going to use but I'm struggling with the variety of ways things come in for me to review. Does this solve that problem or is it just creating another new way? To illustrate what I'm talking about

  1. Hakai salmon and Hakai seagrass came in via the datasets folder and I provided comments as issues
  2. WBTS MBON came in through an issue posted by the data provider and I provided comments there
  3. MBON eDNA Zooplankton came in via I'm not even sure, a pull request?, and I provided a review via a comment here which seems like it's gotten lost and is hard for me to keep track of.
  4. Now we're creating another method.

It kind of feels like we are creating a new way each time and I don't think I can manage that.

@7yl4r
Copy link
Contributor Author

7yl4r commented Nov 22, 2022

I agree that we need to center around one method. And that method should not be emails unless we want to create a public mailing list.

I think that the new suggested method should be the one way going forward. The protocol for going through this process has not be cleanly documented, and I am hoping that this form will help fix that. I am imagining a series of markdown documents with checklists and an accompanying flow-chart for this purpose. Filling this form could be a step in a checklist.

Note that this form still uses github issues as we have been; it just adds some structure to the information we ask for when people create an issue.

resolve Mat's comments
@7yl4r 7yl4r merged commit bc3e2e5 into ioos:main Nov 22, 2022
@7yl4r
Copy link
Contributor Author

7yl4r commented Nov 22, 2022

I merged this PR and created an issue using it for the MBON SE FL eDNA data [ref]. This is what issues created using this template will look like.

@albenson-usgs
Copy link
Contributor

@7yl4r it still says "Datset" in the template. I tried looking at the commits to see if I could figure out where to fix it but I can't find it. Can you fix it?
Capture

7yl4r added a commit that referenced this pull request Dec 9, 2022
reported in #134. thanks @albenson-usgs !
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants