Skip to content

Commit 2789674

Browse files
authored
How to contribute goals, questions, and metrics
1 parent 3950d9f commit 2789674

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,24 @@ in the [GitHub issues tracking for this repository](https://github.com/innersour
1616
Please be aware that all of your contributions will be opened by default and
1717
that those will be licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
1818

19+
## Metrics
20+
21+
This book uses the [Goal-Question-Metric] approach to documenting InnerSource metrics.
22+
[Goals], [questions], and [metrics] are kept in separate files with markdown links between them indicating which are related to one other.
23+
The full graph of relationships is visible in this [graph](https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md).
24+
25+
Add in your scenarios by copying this [goal template], [question template], and/or [metric template], filling them out, and submitting them in pull request.
26+
By adding in your scenarios to the graph, you will be able to see how others approach and interact with them.
27+
You may get new ideas of what metrics answer the questions you have or what additional goals your questions can support.
28+
1929
## Guidelines
2030

2131
When using titles in Markdown, use # for main title, ## for the second header title, etc. It's just to follow the same style :).
2232

33+
[Goal-Question-Metric]: https://en.wikipedia.org/wiki/GQM
34+
[goals]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/goals
35+
[questions]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/questions
36+
[metrics]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/metrics
37+
[goal template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/gqm_goal_template.md
38+
[question template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/gqm_question_template.md
39+
[metric template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/gqm_metric_template.md

0 commit comments

Comments
 (0)