Skip to content
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

Contributing instructions for new goals, questions, and metrics #32

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Contributing instructions for new goals, questions, and metrics #32

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2789674
How to contribute goals, questions, and metrics
rrrutledge Sep 29, 2023
9aa768a
Reference Metrics contribution instructions
rrrutledge Sep 29, 2023
4cc7e48
Update README.md
rrrutledge Sep 29, 2023
ca78252
Merge branch 'master' into rrrutledge-patch-1
rrrutledge Sep 29, 2023
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
Next Next commit
How to contribute goals, questions, and metrics
  • Loading branch information
@rrrutledge
rrrutledge authored Sep 29, 2023
commit 27896742447b2fb6c73340eaf566b55a65d49e03
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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