Merge pull request #32 from InnerSourceCommons/rrrutledge-patch-1

Author: jeffabailey

CONTRIBUTING.md

@@ -16,7 +16,24 @@ in the [GitHub issues tracking for this repository](https://github.com./innersour
 Please be aware that all of your contributions will be opened by default and
 that those will be licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
 
+## Metrics
+
+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).
+
+Add in your scenarios by copying this [goal template], [question template], and/or [metric template], filling them out, and submitting them in pull request.
+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.
+
 ## Guidelines
 
 When using titles in Markdown, use # for main title, ## for the second header title, etc. It's just to follow the same style :).
 
+[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
+[metrics]: https://github.com./InnerSourceCommons/managing-inner-source-projects/tree/master/measuring/metrics
+[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

README.md

@@ -29,19 +29,13 @@ applied InnerSource in your internal software development process.
 ## How Do We Structure Goals, Questions, and Metrics?
 
 Review the [Goal-Question-Metric Approach](./measuring/gqm.md) to further understand how we structure goals, questions, and metrics.
-
 Review [GQM use cases and user journeys](./measuring/gqm_example/README.md) to guide their development.
 
 We document goals, questions, and metrics in separate folders in the [measuring](./measuring) directory.
-Goals link to all related questions, and questions link to all related metrics.
-
-*Templates:*
-
-* [Goal Template](./measuring/gqm_example/gqm_goal_template.md)
-* [Question Template](./measuring/gqm_example/gqm_question_template.md)
-* [Metric Template](./measuring/gqm_example/gqm_metric_template.md)
+You can browse all goals, questions, and metrics in [graph format](./measuring/use_gqm.md). 
 
-We interconnect our goals, questions, and metrics (GQM) in graph format. This approach not only expands our documentation of these aspects but also keeps it well-organized.
+Add in your own scenarios to the graph!
+See the ["Metrics" section of CONTRIBUTING.md](./CONTRIBUTING.md#metrics).
 
 ## References
 

measuring/gqm_example/README.md

@@ -1,10 +1,6 @@
 # How Do I Add A Goal Question Metric (GQM)?
 
-1. Add your goals, questions, and metrics to the following directories (use the templates inside the directories):
-   1. [../goals](../goals/)
-   2. [../questions](../questions/)
-   3. [../metrics](../metrics/)
-2. Update [../use_gqm.md](../use_gqm.md) with graph connections and links.
+See the ["Metrics" section of CONTRIBUTING.md](../../CONTRIBUTING.md#metrics).
 
 # What Is The Goal Question Metric (GQM) Example?