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 Active #197

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

Revising Metric: Issues Active #197

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

ElizabethN commented May 31, 2022

Name of the Metric Being Revised

Issues Active

Link to Original Metric Release Issue

chaoss/wg-evolution#287

Specific Metric Details that Require Attention

  • As in a few other metrics, we offer specific instructions to implement in GrimoireLab. We should make sure these instructions are still correct, or remove them to avoid having to keep up with this in the future. There is no mention of Augur.
  • The Description section is very light (maybe this is ok?)
  • There are parameters which seem to be filters to me
  • Synonyms are listed in Data collection strategies and not in Description
  • Do we need references?

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

Note the "Specific Metric Details that Require Attention" comments above

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

Doing some repo cleanup today and because we are currently updating all metrics to a new template with a refresh, this is ok to close for now.

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