diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32ae6e2..b7014f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,9 +20,12 @@ that those will be licensed under [CC BY-SA 4.0](https://creativecommons.org/lic This book uses the [Goal-Question-Metric] approach to documenting InnerSource metrics. [Goals], [questions], and [metrics] are kept in separate files with markdown links between them indicating which are related to one other. -The full graph of relationships is visible in this [graph](https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md). +The full graph of relationships is visible in this [graph]. Add in your scenarios by copying this [goal template], [question template], and/or [metric template], filling them out, and submitting them in pull request. +After successful merge, a Trusted Committer will manually[^1] add those to the [graph]. +If interested, feel free to [edit the MermaidJS source] of the graph on your own! + By adding in your scenarios to the graph, you will be able to see how others approach and interact with them. You may get new ideas of what metrics answer the questions you have or what additional goals your questions can support. @@ -30,6 +33,9 @@ You may get new ideas of what metrics answer the questions you have or what addi When using titles in Markdown, use # for main title, ## for the second header title, etc. It's just to follow the same style :). +[^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. +At that time this manual step will no longer be needed. + [Goal-Question-Metric]: https://en.wikipedia.org/wiki/GQM [goals]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/goals [questions]: https://github.com/InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/questions @@ -37,3 +43,5 @@ When using titles in Markdown, use # for main title, ## for the second header ti [goal template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/goals/gqm_goal_template.md [question template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/questions/gqm_question_template.md [metric template]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/metrics/gqm_metric_template.md +[edit the MermaidJS source]: https://github.com/InnerSourceCommons/managing-inner-source-projects/edit/master/measuring/use_gqm.md +[graph]: https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md