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

New Metric: Libyear #138

Closed
22 of 24 tasks
sgoggins opened this issue Aug 26, 2021 · 5 comments
Closed
22 of 24 tasks

New Metric: Libyear #138

sgoggins opened this issue Aug 26, 2021 · 5 comments

Comments

@sgoggins
Copy link
Member

sgoggins commented Aug 26, 2021

This issue is created to collect comments about the rolling release of "Libyear"

This metric can be found here: https://github.com/chaoss/wg-risk/blob/master/focus-areas/dependency-risk-assessment/libyear.md

See all release candidates: https://chaoss.community/metrics/

CHAOSS Metric Quality Checklist

This checklist is used for new and updated metrics to ensure we follow CHAOSS quality standards and processes. Below checklist items don’t have to be completed all at once: create the metric release candidate issue first and then start working on the checklist.

Process

  • Create the “review issue” in the authoring WG’s repo for comments during review period and paste this template in
  • Create pull request to edit or add metric to WG’s repo (after checking Content Quality and Technical Requirements below)
  • Add the new metric or metric edit to release notes issue in working group repo
  • Update the Metrics Spreadsheet
  • 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.
  • Metric was added to website

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.

Content Quality

  • Required headings are filled in, including Questions.
  • Description provides context to metric
  • Objectives list sample uses for the metric and desired outcomes
  • If any, DEI uses of the metric are included Objectives
  • Optional headings that have no content were removed
  • Contributors section lists those contributors that want to be named
  • The name of the metric is the same in (1) metric heading, (2) metric file name, (3) focus area, (4) metrics spreadsheet, (5) “review issue”, (6) translation issue, and (7) website

Technical Requirements

  • Message in the metric markdown file that the metric will be part of the next regular release is at top of page and the links are correct (this is in the metric template)
  • Metric file name is the full metric name and only contains lower case letters and hyphens (“-”) for spaces
  • Images are included using markdown and relative links (as described in the metrics template)
  • Images have at least one empty line above and below them
  • Ensure images are placed in image folder and followed naming convention
  • If new focus area is created, ensure focus area is added to wg repo readme and focus area folder readme
  • Within the focus area, add the metric in the table and provide the link to the metric and metric question
  • Ensure tables within metric are converted as image and placed in the image folder (both original MD and screenshotted PNG format) and follow the naming convention
  • No HTML code in the metrics markdown file
@klumb
Copy link
Member

klumb commented Sep 1, 2021

Please double-check that the naming convention for this metric is correct and the same in all locations.

I see:
Libyear
Libyears
Libyear of Dependencies

The name should be consistent and the file name should match the full name of the metric.

If a change is made to the filename, please tag me so that I can make the change on the website.

@lucasgonze
Copy link
Contributor

I had a hard time understanding the metric based on the writing of the question: "Question: What is the age of the project’s dependencies compared to current stable releases?" Introducing the purpose of the metric would communicate more clearly: "How much risk is there from out-of-date dependencies?"

@klumb
Copy link
Member

klumb commented Oct 16, 2021

@sgoggins Is this ready for release?

@germonprez
Copy link
Contributor

@sgoggins is this metric released? If so, can this issue be closed?

@klumb
Copy link
Member

klumb commented Apr 12, 2022

This metric was released. I am closing the issue.

@klumb klumb closed this as completed Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants