Repository: chaoss/metrics Branch: main Commit: fae1f4dfc533 Files: 7 Total size: 12.3 KB Directory structure: gitextract_j7fvgphs/ ├── .github/ │ ├── CONTRIBUTING.md │ └── FUNDING.yml ├── LICENSE ├── README.md ├── RELEASING.md └── resources/ ├── checklist-quality.md └── metrics-template.md ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/CONTRIBUTING.md ================================================ # How to Contribute See the CHAOSS [CONTRIBUTING.md][contrib] for details. [contrib]: https://github.com/chaoss/governance/blob/master/CONTRIBUTING.md ## How to become a repository maintainer Maintainers are responsible and capable for accepting pull requests. We strive to have three maintainers and a new maintainer may replace a current maintainer. Current maintainers identify a new maintainer based on engagement in issues, pull-requests, and other community engagement related to this repository. ## Additional Resources * [CHAOSS Website][chaoss] * [CHAOSS Metrics Wiki][wiki] [chaoss]: https://chaoss.community/ [wiki]: https://wiki.linuxfoundation.org/chaoss/metrics ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: # Replace with a single Patreon username open_collective: chaoss ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge username liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2017 CHAOSS Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================ # CHAOSS Metrics Welcome to the CHAOSS Metrics repository. CHAOSS Metrics work captures metrics for open source community health more transparent and actionable. ## Current CHAOSS Metrics Release The current release of CHAOSS metrics can be found at: https://chaoss.community/metrics/. ## Working on CHAOSS Metrics The current release of CHAOSS metrics represents the published work being done by CHAOSS Metrics Working Groups. The work in the WGs does not necessarily coincide with the formally releases metrics as the WGs are developing new, yet-to-be-released metrics. Work being done in the CHAOSS WGs can be found at: [CHAOSS Common Metrics Working Group](https://github.com/chaoss/wg-common) [CHAOSS Diversity & Inclusion Working Group](https://github.com/chaoss/wg-diversity-inclusion) [CHAOSS Evolution Working Group](https://github.com/chaoss/wg-evolution) [CHAOSS Value Working Group](https://github.com/chaoss/wg-value) [CHAOSS Risk Working Group](https://github.com/chaoss/wg-risk) ## Metrics Resources [Metrics Template](resources/metrics-template.md) ## Contribute and Participate to the CHAOSS Project and Metrics Working Groups [Contribute and Participate](https://chaoss.community/participate/). ## Repository Maintainers - [Dawn Foster](https://github.com/geekygirldawn) - [Georg Link](https://github.com/GeorgLink) - [Matt Germonprez](https://github.com/germonprez) - [Ben Lloyd Pearson](https://github.com/BenLloydPearson) [How to become a maintainer](.github/CONTRIBUTING.md#how-to-become-a-repository-maintainer) # License All contributions to implementation-agnostic metrics and standards, including associated scripts, SQL statements, and documentation, will be received and made available under the MIT License (https://opensource.org/licenses/MIT). ================================================ FILE: RELEASING.md ================================================ ## RELEASING CHAOSS METRICS This document provides requirements for releasing CHAOSS metrics. Below defines the necessary steps: 1. Metrics must be associated with a CHAOSS working group 2. Metrics must be associated with a working group's focus area 3. Metrics must have an associated question that is being addressed 4. Metrics must have an associated detail page providing more information about the metric. Examples: * https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors.md * https://github.com/chaoss/wg-diversity-inclusion/blob/master/focus-areas/governance/board-council-diversity.md 5. Metrics must be consistently referenced across the CHAOSS organization. This typically includes (1) the name/question listing in the focus area, (2) the name/question listing on the detail page, and (3) name/question listing in the aggregate metric list at: https://github.com/chaoss/metrics 6. Metrics must be identified as 'ready for release' in the following spreadsheet: * https://docs.google.com/spreadsheets/d/1_jwkwzs8s6SAm2vVY-8lzTQk3YT0YpOveTlKOwjd2eQ/edit#gid=0 Once these criteria are met, open an issue at: https://github.com/chaoss/metrics indicating the working group and metrics for release. ================================================ FILE: resources/checklist-quality.md ================================================ This issue is created to collect comments about the rolling release of "______" This metric can be found here: https://github.com/chaoss/xxxxxxx/xxxxxxx/xxxxxxx.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](https://docs.google.com/spreadsheets/d/1tAGzUiZ9jdORKCnoDQJkOU8tQsZDCZVjcWqXYOSAFmE/edit) - [ ] Create issue in [CHAOSS/Translations repository](https://github.com/chaoss/translations) 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 in 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](https://github.com/chaoss/metrics/blob/master/resources/metrics-template.md)) - [ ] 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](https://github.com/chaoss/metrics/blob/master/resources/metrics-template.md) - [ ] 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 ================================================ FILE: resources/metrics-template.md ================================================ # {Name of Metric} ### This metric is a release candidate. To comment on this metric please see Issue [#[put the respective Issue Number here]](URL to issue). Following a comment period, this metric will be included in the next regular release. Question: Synonyms: [Known synonyms for the metric - only common synonyms - this not meant to be a diffinitive list] ## Description A description of what the metric is and what it captures. ## Objectives Answer the question for why someone wants to measure this metric and what can be known with it. [Each metric has the potential to influence diversity, equity, and inclusion on an open source project. Please consider these factors when framing metrics objectives.] ## Implementation __The usage and dissemination of health metrics may lead to privacy violations. Organizations may be exposed to risks. These risks may flow from compliance with the GDPR in the EU, with state law in the US, or with other law. There may also be contractual risks flowing from terms of service for data providers such as GitHub and GitLab. The usage of metrics must be examined for risk and potential data ethics problems. Please see [CHAOSS Data Ethics document]() for additional guidance__ Provide details on how to measure the metric, collect the data, and analyze it. The following sub-headings are optional but help to structure the different aspects of implementation. ### Filters (optional) Include a Filter ### Visualizations (optional) Include visualizations such as screenshot of the metric. There may be many more visualizations for this metric, we only want to provide a flavor for what this metric is about. Please provide attribution where the screenshot was taken, e.g. what software. ### Tools Providing the Metric (optional) Metric must be currently deployed/available, in contrast to a tool having the "potential" to provide the metric. Provide direct link to implementation/documentation, if applicable ### Data Collection Strategies (Optional) If there are several different ways to collect data for this metric, list them here. This may include expressing a metric in different ways. ## References Blog posts, websites, academic papers, or books that mention the metric and provide more background. ## Contributors List of people who would like to be mentioned as contributors to this metric ``` ***This metric was last reviewed on [date] as part of [ release version ] [or recurring review process]*** -------- # Notes about document formatting ***The following rules are applicable for the above defined metric template:*** * Metrics naming - In cases where the metric name is also a descriptor, please use this convention: "specific thing being measured"-"further description if needed" EX: `pull-requests-open.md` EX: `issues-first-response.md` * Please provide attribution for where the image was taken, e.g. what software. * All the images should be using the markdown syntax: `![]()` * All the images should be using an absolute path to the images directory (Absolute paths are necessary, becuase these documents will be presented on a different platform/server). * Eg. `![alt text](https://github.com/chaoss/working-group/focus-area//images/metric-name_img.png)` * No tables should be used in the metrics, alternatively you can insert an image of the table * No HTML code should be used in the metrics, only markdown * Please remove formatting text and (Optional) tags from the metric prior to publishing * There should be at least one `\n` (newline) between: * 2 images * An image and text * An image and heading \ This is to solve the wrapping issue in the release PDF \ Eg. - ``` # Some heading ![alt text](images/metric-name_test-img1.png) ![alt text](images/metric-name_test-img2.png) * Some random text ![alt text](images/metric-name_test-img3.png) Another text line ```