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

Revising Metric: Issues New #196

Closed
1 of 19 tasks
ElizabethN opened this issue May 31, 2022 · 2 comments
Closed
1 of 19 tasks

Revising Metric: Issues New #196

ElizabethN opened this issue May 31, 2022 · 2 comments
Assignees
Labels
Revisiting Metric Previously released metric that is being revisited and updated

Comments

@ElizabethN
Copy link
Member

Name of the Metric Being Revised

Issues New

Link to Original Metric Release Issue

Original Issue: chaoss/wg-evolution#286

Specific Metric Details that Require Attention

  • There is no "Tools" section, nor a mention of Grimoire Lab or Augur at all
  • This is one of our more heavily referenced metrics, so we should read through it to make sure it meets our standards. It hasn't been reviewed in years.
  • Definitions are in "Data Collection Strategies" but they should be in the "synonyms" section
  • There are "parameters" which seem like they could be filters to me

Checklist

Process

  • Create the “revising metric” labeled issue in the authoring WG’s repo for comments during review period
  • Create pull request of revised metric to WG’s repo (after checking Content Quality and Technical Requirements below)
  • Add the metric revision to release notes issue in working group repo
  • Update the Metrics Spreadsheet to indicate that the revised metric is under review
  • Create issue in CHAOSS/Translations repository to kick-off translation to other languages (please use the the translation issue template)
  • "Metric Candidate Release" label added to the metric release candidate issue when fully ready fo release

When above steps are completed:

  • Announce new/updated metric on mailing list, newsletter, community Zoom call, and Twitter. This can be coordinated with the community manager and can be done as a collective of all revised metrics from the CHAOSS community.

Content Quality (check all that apply)

  • Date of last review has been added to the revised metric at the bottom of the markdown file (month/year)
  • Formatting changes have been made
  • Minor editorial changes have been made
  • Major editorial changes have been made
  • Metric adheres to the current metrics template
  • Metric name has changed and necessary updates are made to the WG README table and metrics tracking spreadsheet

Technical Requirements for any Revisions

  • Metric file name is the full metric name and only contains lower case letters and hyphens (“-”) for spaces
  • Images are included using markdown and absolute path links (as described in the metrics template)
  • Images have at least one empty line above and below them
  • Images are placed in image folder and followed naming convention
  • If new a focus area is created, ensure focus area is added to wg repo readme and focus area folder readme
  • There is no HTML code in the metrics markdown file
@ElizabethN ElizabethN added the Revisiting Metric Previously released metric that is being revisited and updated label May 31, 2022
@ElizabethN
Copy link
Member Author

Of particular note are the "Specific Details that require attention" section above

@ElizabethN ElizabethN transferred this issue from chaoss/wg-evolution Apr 11, 2023
@ElizabethN
Copy link
Member Author

Doing a little repo cleanup today and I'm going to close this, as we are updating all metrics to the new template and doing a refresh of them all in the process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Revisiting Metric Previously released metric that is being revisited and updated
Projects
None yet
Development

No branches or pull requests

2 participants