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.

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

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

Open
riverma opened this issue Jun 6, 2024 · 2 comments
Open
Assignees
Labels
more requested Requested by community members at a medium level software lifecycle Process improvements involving developing, testing, integrating, deploying software

Comments

@riverma
Copy link
Collaborator

riverma commented Jun 6, 2024

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:

  • For complex, multi-repository metrics gathering: Apache DevLake
  • Simple, single repository metrics gathering: a plug-and-play GitHub Action based tool or command-line program

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 riverma self-assigned this Jun 6, 2024
@riverma riverma added more requested Requested by community members at a medium level software lifecycle Process improvements involving developing, testing, integrating, deploying software labels Jun 6, 2024
@riverma
Copy link
Collaborator Author

riverma commented Jun 6, 2024

@riverma riverma changed the title [Improve Existing Best Practice Guide]: Metrics [Improve Existing Best Practice Guide]: Easier DORA Metrics Gathering Jun 6, 2024
@yunks128
Copy link
Contributor

Updated the metrics readme by adding a simple metrics gathering:
https://github.com/yunks128/slim/tree/yunks128-issue-160-metrics/docs/guides/software-lifecycle/metrics

@yunks128 yunks128 self-assigned this Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
more requested Requested by community members at a medium level software lifecycle Process improvements involving developing, testing, integrating, deploying software
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants