Skip to content

Commit 6ac9339

Browse files
authored
Merge pull request #38 from InnerSourceCommons/rrrutledge-patch-1
Update CONTRIBUTING.md
2 parents aba130e + 86082b2 commit 6ac9339

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,28 @@ that those will be licensed under [CC BY-SA 4.0](https://creativecommons.org/lic
2020

2121
This book uses the [Goal-Question-Metric] approach to documenting InnerSource metrics.
2222
[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).
23+
The full graph of relationships is visible in this [graph].
2424

2525
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+
After successful merge, a Trusted Committer will manually[^1] add those to the [graph].
27+
If interested, feel free to [edit the MermaidJS source] of the graph on your own!
28+
2629
By adding in your scenarios to the graph, you will be able to see how others approach and interact with them.
2730
You may get new ideas of what metrics answer the questions you have or what additional goals your questions can support.
2831

2932
## Guidelines
3033

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

36+
[^1]: [#37](https://github.com./InnerSourceCommons/managing-inner-source-projects/issues/37) will automate the addition of new goals, questions, and metrics to the graph.
37+
At that time this manual step will no longer be needed.
38+
3339
[Goal-Question-Metric]: https://en.wikipedia.org/wiki/GQM
3440
[goals]: https://github.com./InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/goals
3541
[questions]: https://github.com./InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/questions
3642
[metrics]: https://github.com./InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/metrics
3743
[goal template]: https://github.com./InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/gqm_goal_template.md
3844
[question template]: https://github.com./InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/gqm_question_template.md
3945
[metric template]: https://github.com./InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/gqm_metric_template.md
46+
[edit the MermaidJS source]: https://github.com./InnerSourceCommons/managing-inner-source-projects/edit/master/measuring/use_gqm.md
47+
[graph]: https://github.com./InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md

0 commit comments

Comments
 (0)