Skip to content

Commit 6105d76

Browse files
authored
Merge pull request #188 from VSevagen/community-health
[docs] Add community health section
2 parents 69c4206 + 5d5f9a9 commit 6105d76

7 files changed

Lines changed: 127 additions & 0 deletions

File tree

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
layout: default
3+
title: Code Development Activities
4+
nav_order: 4
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Understand the types and frequency of activities involved in developing code
11+
12+
The goal of this area is to identify and understand the source code changes over
13+
time and the frequency of those changes over time. For example,
14+
15+
- What changes were made to the source code during a specified period ?
16+
- How projects manage lifecycle of their version control branches ?
17+
- What is the sum of the number of lines touches( lines addes plus lines removed
18+
) in all changes to the source code during a certain period. ?
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: default
3+
title: Code Development Efficiency
4+
nav_order: 5
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Understand how efficiently activities around code development get resolved.
11+
12+
The goal of this area is to identify how efficiently any code related activity
13+
get resolved. For example,
14+
15+
- What is the time taken to merge a change request ?
16+
- How many change requests are present in a code change ?
17+
- What reviews of change requests ended up being declined during a certain
18+
period ?
19+
- What is the ratio of change request accepted to rejected ?
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: default
3+
title: Contributions
4+
nav_order: 1
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Identify what contributions are being made
11+
12+
The goal of this area is to identify what kind of contributions (wiki edit,
13+
documentaion, bug fix) are being made to a project.

docs/community-health/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
title: Community Health
4+
permalink: /community-health
5+
nav_order: 6
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Understanding Community health
11+
12+
GrimoireLab is the platform through which community health can be monitored but
13+
what is community health and how can we define it ?
14+
15+
Community health is the potential that a project can continue developing quality
16+
software. There are different ways that it can be evaluated. For example, we can
17+
analyze the health of a community through the code quality, the activity in the
18+
community ( are the contributors active, are the issues being resolved, the
19+
diversity of contributors) and the resources needed by the project.
20+
21+
Check out the following focus areas depending on your required metric.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
title: Issue Resolution
4+
nav_order: 7
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Identify how effective community is at adressing issues from community participants
11+
12+
The goal of this area is to identify how effective the community is at
13+
addressing issues from community participants. For example,
14+
15+
- What is the number of new issues created during a certain period ?
16+
- What is the count of issues that showed activity during a certain period ?
17+
- What is the count of issues that were closed during a certain period ?
18+
- What is the average time that open issues have been open ?
19+
- What is the time period between the opening of an issue and a response in the issue
20+
thread from another contributor ?
21+
- How much time taken to close an issue ?

docs/community-health/people.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
title: People
4+
nav_order: 3
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Understand personal engagement with projects
11+
12+
The goal of this area is to identify and understand organizational and personal
13+
engagement with open source projects. For example,
14+
15+
- Who are the contributors to your project ?
16+
- What is the geographical diversity of your contributors ?
17+
- What is the organizational diversity of your contributors ?

docs/community-health/time.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
layout: default
3+
title: Time
4+
nav_order: 2
5+
parent: Community Health
6+
has_children: true
7+
has_toc: true
8+
---
9+
10+
# Identify when contributions are made
11+
12+
The goal of this area is to identify when does contributions from organizations
13+
and people happen. For example,
14+
15+
- What are the timestamps of contribution activities ?
16+
- What is the duration for the review of a change request ?
17+
- How much time for an activity (issue, change request) to receive any response
18+
?

0 commit comments

Comments
 (0)