Review of contribution instructions for GQM

[dellagustin-sap]

Links and References

• Contributing instructions for new goals, questions, and metrics #32
• Action item from https://docs.google.com/document/d/1hfKXbvydj3ENajrfA4l1KqM1qe3d6h1dawbQAB1kKjU/edit
  • Status update on https://docs.google.com/document/d/1oYsoGgo10sZAcrKp7sKqvZVoIqdwxKcuEsSc2b3XmDA/edit

[dellagustin-sap]

@rrrutledge I have reviewed the instructions.
What I think is missing is information on how the graph is generated (even if that is a manual process at the moment that is not available to the contributor).
Is it currently a manual process, or is there a script for it somewhere?
Eventually it would be good if the contributor could generate the graph, as a way to validate if the format of the markdown is as expected.

Another comment, even though the contribution instructions are clear, the current structure of the chapter What, When and How to Measure is confusing.
For instance, the Goal-Question-Metric Approach sub-section is separate from the sections Goals using Metrics and Use Goals, Questions, and Metrics.

[jeffabailey]

@dellagustin-sap

Is it currently a manual process, or is there a script for it somewhere?

Yes, it's a manual process at the moment.

Future state is a script, but that's not done yet. I created a local branch that's parsing the markdown and will eventually build the mermaid graph.

Another comment, even though the contribution instructions are clear, the current structure of the chapter What, When and How to Measure is confusing.

Agreed, I noticed that as well. We'll make sure it all makes cohesive sense.