wg-metrics-development
wg-metrics-development copied to clipboard
Metrics Revision: Types of Contributions
Name of the Metric Being Revised
Types of Contributions https://github.com/chaoss/wg-common/blob/main/focus-areas/contributions/types-of-contributions.md
Link to Original Metric Release Issue
https://github.com/chaoss/wg-common/issues/56
Specific Metric Details that Require Attention
- Description needs to clearly identify what is being measured. Move the first sentence into the objective section.
- Add explicit objectives and DEI objective (there is some content here but I think we need a little more)
- Link to relevant CHAOSS metrics in the "Collect Trace Data:" section
- Update template and add content where appropriate
- Add revision date
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