search

microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
27 stars 8 forks source link

Clean up GitHub Issues in this repository #1085

Open turbomam opened 1 year ago

turbomam commented 1 year ago

what are the general patterns of things we could do to make the nmdc-schema issues more concise, integrated and actionable?

is iterating over the nmdc-schema issues something that could be done with one of the BBOP groups ChatGPT repos?

eecavanna commented 1 year ago

Here's what I plan to do, with the goal of making the Issues list easier for @turbomam (and other maintainers of the repository) to read and act upon:

  1. Standardize the Issue titles (in an attempt to make it easier to read a list of Issues).
  2. Apply "bug", "enhancement", and other labels (in an attempt to make it easier to sort and filter the Issue list).
  3. Apply "small", "large", etc. labels (if I feel confident in my assessment of how much work would be involved).
eecavanna commented 1 year ago

Here's a screenshot depicting what I had in mind for "Standardize the Issue titles":

image
eecavanna commented 9 months ago

what are the general patterns of things we could do to make the nmdc-schema issues more concise, integrated and actionable?

I like to name issues using one of the following two formats (only):

  1. Do thing
  2. Thing is behaving in some way

And not:

Here are some examples from recently-created issues:

Current Proposal Issue #
what predicates should be asserted in visualizations, esp for MIxS slots Determine which predicates (someone wants to) be asserted... 1722
what to exclude from visualizastion? Determine what (someone wants me) to exclude from (what) visualization 1721
Do we have a policy about including 'none' as a permissible value in enumerations? Determine whether NMDC team has... 1680
invalid example data file naming/commenting practice Standardize file names and comments for example data files 1679

I prefer the ones in the "Proposal" column because I can read the issues list as a kind of "to do" list.

eecavanna commented 7 months ago

Above, I posted the convention I try to follow for naming issues, along with how I might apply that to some existing issues.

At this point, I don't plan to go through the issues in this repo and do that. So, I will un-assign the issue from myself.

Today, the team talked about the possibility of having a hackathon session where people clean up issues.