NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization
https://nasa-ammos.github.io/slim/
Apache License 2.0
24 stars 9 forks source link

[Improve Existing Best Practice Guide]: Easier DORA Metrics Gathering #160

Open riverma opened 3 weeks ago

riverma commented 3 weeks ago

Checked for duplicates

Yes - I've already checked

Best Practice Guide Category

Software Lifecycle

Best practice guide URL

https://nasa-ammos.github.io/slim/docs/guides/software-lifecycle/metrics/

Describe the improvement

I found the recommended tool in the Metrics guide (Apache DevLake) to be powerful but complicated to use. The current setup requires a server (or local machine), and a series of steps to configure access and metrics collection from GitHub.com repositories. The metrics collection interface requires some in-depth knowledge of DevLake as well. Some dev leads may not bother with the setup required if they don't see enough value for time invested for simpler projects, and SLIM won't be able to submit PRs to help them infuse more easily. I think we need a super easy tool suggestion for simple project setups that's PR infusible. I suggest we have two tool recommendations for projects in this guide:

I was looking at this project: https://github.com/DeveloperMetrics

They have simple GitHub Action(s) which can be dropped in to a repository to automatically collect rough DORA metrics and results can be shared on project README's via badges. See output example. The advantage of recommending a tool like this is that SLIM can automatically propose this action to repositories in the form of a pull request and get people using DORA metrics for their projects more easily for simple projects.

riverma commented 3 weeks ago

CC @ddalton-swe @PaulMRamirez @ewferg @jpl-jengelke @yunks128 @lewismc.