This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
oss-health-metrics:metrics:transparency [2017/04/17 18:35] abuhman [1. Acronym] |
oss-health-metrics:metrics:transparency [2017/05/18 00:13] GeorgLink add link back to list |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | __**[[oss-health-metrics:metrics|<< Back to List of Activity Metrics]]**__ | ||
====== Transparency ====== | ====== Transparency ====== | ||
- | ===== 1. Acronym ===== | ||
+ | ===== 1. Description ===== | ||
+ | Number of comments per issue. | ||
+ | Discussion is occuring openly - could also indicate level of agreement. | ||
- | ===== 2. Alternate Names ===== | + | ===== 2. Use Cases ===== |
- | Some metrics might be known by different names, e.g. bus factor and truck factor. | + | ===== 3. Sample Visualization ===== |
- | ===== 3. Classification ===== | + | ===== 4. Sample Implementation ===== |
- | Classifications might include: Community/Code/Risk, or Activity/Viability/Risk, or generic/composite metric | + | === GitHub === |
- | + | SELECT avg(avg_num_comments), project_name | |
- | ===== 4. Description ===== | + | FROM |
- | A description of what the metric is and what it captures. | + | ( |
- | + | SELECT count(comment_id) as avg_num_comments, projects.name as project_name, projects.id as project_id | |
- | ==== Visualization ==== | + | FROM msr14.issue_comments |
- | + | join issues on issue_comments.issue_id = issues.id | |
- | Include a sample visualization (screenshot) of the metric | + | join projects on issues.repo_id = projects.id |
- | ==== Interpretation ==== | + | GROUP BY projects.id, issues.id |
- | Provide examples of how the metric might inform different stakeholders. | + | ) as comments_per_issue |
+ | GROUP BY project_id | ||
===== 5. Known Implementations ===== | ===== 5. Known Implementations ===== | ||
- | Examples of where and how metric is used. (include links to dashboard or location where metric is visible or is talked about having been used). | ||
- | |||
- | ===== 6. Data Source ===== | ||
- | The orginal data source or other metric this one is building on. | ||
- | |||
- | ===== 7. Pseudo Code/Query ===== | ||
- | A generic calculation (code) or SQL query that generates the metric. | ||
- | |||
- | ===== 8. Data Exchange Format ===== | ||
- | Describe how the metric is encoded for sharing and communicating between programs. | ||
- | |||
- | ===== 9. References to Academic Literature ===== | ||
- | Papers released in the academic literature that uses the metric. | ||
- | |||
- | ===== 10. Internet References ===== | ||
- | Links to websites that add value to the understanding of the metric. | ||
- | ===== 11. Contributors ===== | + | ===== 6. External References (Literature) ===== |
- | Authors of the metric page and authors who made significant changes. | + |