Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
83 lines (55 sloc) 5.15 KB

Focus Area: Code Development

Scope: Aspects related to how the source code changes over time, and the mechanisms that the project has to perform and control those changes.

Goals

  • Activity: Learning about how much activity in involved in changing (or adding) code
  • Efficiency: Learning how effective new code is merged into the code base
  • Quality: Learning about the processes to improve/review quality that are used (for example: testing, code review)

Observations:

  • Usually these goals, which in general correspond to the evaluation of some processes, are consiedered over a certain time period. Therefore, questions and metrics will also refer, usually, to time periods.

  • Since the focus area is code development, goals (and therefore relevant questions and metrics) are specific for code development. Therefore, any metric related to these goals should be considered as fitering only data relevant to code development (for example, changes only to source code files). In any case, very likely these same goals could be applied to other artifacts (such as documentation) when it is developed in a similar way to source code.

  • For Quality, we assume that there are measurable processes to improve/review quaitly (testing, code review, etc.). If they don't exist, this goal cannot be satisfied.

Questions & metrics

[Work in progress]

Goal Activity:

  • Question Changes: How many changes are happening to the code base, during a certain time period?

    • Metric Code_Changes_No(Period): Number of changes to the code base (see Code_Changes)
    • Metric Code_Lines_Changed_No(Period): Number of lines changed in the source code
    • Metric Code_Changes_Lines_No(Period): Aggregated number of lines touched in all changes.
  • ...

Goal Efficiency:

  • Question Proposals: How efficient is the project in considering proposals for changes, for proposals proposed during a certain time period?

    • Metric Proposal_Duration(Period): For how long proposed changes are discussed before they are accepted
    • Metric Proposal_Acceptance(Period): How many proposals are finally accepted
    • Metric Proposal_Participants(Period): How many
  • ...

Goal Quality:

  • ...

Legacy metrics and questions

We're in the process of discussing questions and metrics. Meanwhile, below is the former list of metrics, and their related questions.

Metric Question
Pull Requests Merged What is the number of code commits?
Lines of Code Changed What is the number of lines of code changed?
Code Reviews What is the number of code reviews?
Pull Request Merge Duration What is the duration of time between code merge request and code commit?
Code Review Efficiency What is the number of merged code changes/number of abandoned code change requests?
Maintainer Response to Merge Request Duration What is the duration of time for a maintainer to make a first response to a code merge request?
Code Review Iteration What is the number of iterations that occur before a merge request is accepted or declined?
Forks Forks are a concept in distributed version control systems like GitHub. It is a proxy for the approximate number of developers who have taken a shot at building and deploying the codebase for development.
Pull Requests Open Number of open pull requests.
Pull Requests Closed Number of closed pull requests.
Pull Request Comment Duration The difference between the timestamp of the pull request creation date and the most recent comment on the pull request.
Pull Request Comment Diversity Number of each people discussing each pull request.
Pull Request Comments Number of comments on each pull request.

Disclaimer: The name/question pairs listed are not meant to represent a fully comprehensive list. It is expected that this list will evolve as people have insights and thoughts about the name/question pairs that comprise Growth-Maturity-Decline.

Tooling: The name/question pairs are intended to be a starting point for CHAOSS-related software. It is expected that this list will evolve based on the ability (or inability) of software to successfully implement the specific name/question pairs.

Background: The name/question pairs have been identified based CHAOSS-related outreach activities. We thank everyone who participated.

How to contribute: