wg-metrics-development
wg-metrics-development copied to clipboard
Revising Metric: Issues Closed
Name of the Metric Being Revised
Issues Closed
- Website: https://chaoss.community/metric-issues-closed/
- File: https://github.com/chaoss/wg-evolution/blob/main/focus-areas/issue-resolution/issues-closed.md
Link to Original Metric Release Issue
chaoss/wg-evolution#288
Specific Metric Details that Require Attention
- As in the other Issues metrics, there are specific instructions for implementing this metric in GrimoireLab, so we should verify these are accurate or remove them to keep from having to check this in the future. Also, no mention of Augur.
- The objectives section could use some work
- There are parameters which seem like filters to me
- Synonyms are in "Data Collection Strategies" and not the Description section
- Do we need references?
- This is one of our more heavily referenced metrics, so we should make sure it's :sparkles:
Checklist
Process
- [x] 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
Note the "Specific Metric Details that Require Attention" section above
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.