Skip to content

Update CONTRIBUTING.md #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffabailey merged 1 commit into from
Oct 6, 2023
Merged

Update CONTRIBUTING.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,28 @@ 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.

## Guidelines

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
[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
[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