search

NASA-AMMOS / slim

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

Metrics Best Practices #126

Closed ddalton-swe closed 3 months ago

ddalton-swe commented 6 months ago

Purpose

Live Demo of Guide Here: https://ddalton-jpl.github.io/slim/docs/guides/software-lifecycle/metrics/

Screenshot 2024-01-18 at 9 54 08 AM

Screenshot 2024-01-18 at 9 54 35 AM

riverma commented 6 months ago

@ddalton-jpl - could we move the metrics top-level folder you've created to one of our sub-folders by topic? i.e. slim/docs/guides. Probably the governance or software-lifecycle sub-topics would be appropriate depending on how your content looks. The idea is that all of our guides should fall under our three key objectives for the project as documented in our scope diagram.

riverma commented 5 months ago

Hey @ddalton-jpl - I'd like to give this a whirl with an actual instantiation of the SLIM website. Could you make your SLIM fork's website public? Here's an example GitHub Settings page config of my fork having a public website generated (you'll need to trigger the workflow manually).

Screenshot 2024-01-25 at 9 26 06 AM

ddalton-swe commented 5 months ago

The site should be hosted now

riverma commented 5 months ago

The site should be hosted now

Thanks @ddalton-jpl! Could you make sure to merge the latest of nasa-ammos/slim:main to your proposed branch. That would help make sure you have the latest version of the website.

The site should be hosted now

Thanks @ddalton-jpl! Could you make sure to merge the latest of nasa-ammos/slim:main to your proposed branch. i.e. this rendering.

Link: https://ddalton-jpl.github.io/slim/docs/category/software-metrics

riverma commented 4 months ago

@ddalton-jpl - this is looking good. I'll run through it one more time with suggestions if I have them!

One thing this PR needs is a registry entry for our search. See here: https://nasa-ammos.github.io/slim/docs/contribute/submit-best-practice#add-entry-to-the-registry

ddalton-swe commented 3 months ago

LGTM! This is great @ddalton-jpl - thanks for the hard work putting this together. It's going to help a lot of projects moving forward.

Approved - but one small note: you're still committing the docs/guides/software-lifecycle/application-starter-kits/.DS_Store file. Just make sure to make one more commit un-adding that particular file and we're good.

It'd be great to get additional community input on your contribution btw!

Okay, that has been fixed.

lewismc commented 3 months ago

@ddalton-jpl I ran through the entire DevLake install and configuration. Everything worked nicely once I was able to discover the script on your forked branch. I would suggest that you put a license header in that file as well 👍

This is a really nice PR and will be of tremendous utility to those who recognize it’s value.

ddalton-swe commented 3 months ago

@ddalton-jpl I ran through the entire DevLake install and configuration. Everything worked nicely once I was able to discover the script on your forked branch. I would suggest that you put a license header in that file as well 👍

This is a really nice PR and will be of tremendous utility to those who recognize it’s value.

Hey @lewismc! Thanks for the feedback. Could you elaborate a bit more on the license header?