DSACMS / repo-scaffolder

Templates and commandline tools for creating repositories for US Federal open source projects

Creative Commons Zero v1.0 Universal

21 stars 7 forks source link

Project Rotation: repometrics.json #97

Open decause-gov opened 1 month ago

decause-gov commented 1 month ago

MENTOR

@natalialuzuriaga
SWE USDC 2023
Communication Channel(s) for your team/project (e.g. Slack Channel URL, GitHub Repo URL, etc...)

BRIEF DESCRIPTION

source a list of user generated metrics/labels to include in repometrics.json
create a repometrics.json file that users can edit manually
create a cookiecutter.json file that edits repometrics.json programmatically

SCOPING

Days

SKILLS NEEDED

e.g. Back-end, Webdev

REQUIRED DELIVERABLES

DESIRED DELIVERY WINDOW

June
July
August
Any

NOTES/INSPO

formatted metrics.json inspo: https://github.com/DSACMS/metrics/tree/main/app/site/_data/DSACMS/metrics
cookiecutter inspo (link)

ACKNOWLEDGEMENTS

[X] - Yes, I agree to spend file a project proposal ticket
[ ] - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
[ ] - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
[ ] - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template

decause-gov commented 1 month ago

06/17:

Met with Nat. Discussed data for inputs and tags
planning to meet again tomorrow to finalize as a team
will go over different libs
goal: have all repometrics identified for the .json file
goal: ideas/mockups for a visualization.
goal: simple text in the repo reports

decause-gov commented 3 weeks ago

06/21:

Determined fields for repometrics.json
PR incoming for template on repo-scaffolder
complete: repometrics identified
Next Week: mockups
future: text in repo reports

decause-gov commented 3 weeks ago

06/24:

Bulk of the code exists, will change templates, and then move on to creating mockups.
Goal: finish templates, create mocks.
Stetch: Start implementing in reports!

RicardoZamora01 commented 3 weeks ago

Note: To have nested cookiecutters, the parent cookiecutter.json must have the flag:

"_copy_without_render": [<subdirectory>]

this will copy the subdirectory and the contents (child cookiecutter) without invoking it.

https://stackoverflow.com/questions/76262434/how-do-i-create-a-nested-cookiecutter

IsaacMilarky commented 2 weeks ago

Good work on the tier 2 repometrics https://github.com/DSACMS/repo-scaffolder/pull/106
ACTION: replace Python script with Bash script before PR merge, same cadence with tier 3 and tier 4
Not going to be creating a repometrics.json file, instead going to use the code.json file 👍

IsaacMilarky commented 2 weeks ago

7/1:

Merged tier 2, need to do tier 3 and 4
Need to figure out how to get data on metrics site
ACTION: Create frontend ticket for repometrics on the metrics website
ACTION: Create backend ticket for repometrics on the metrics website
Get rest of the tiers merged first

RicardoZamora01 commented 2 weeks ago

7/3:

all tiers PR's merged!
ACTION: User research plan - Get feedback from around CMS with forming the categories/fields, update code with new fields if needed

IsaacMilarky commented 1 week ago

7/8:

Follow up on User Research Plan. See if we want to add fields or not.
Close after action item completed

IsaacMilarky commented 5 days ago

7/12:

Still setting up meetings and working on User Research

natalialuzuriaga commented 2 days ago

7/15:

Backend is all done 🙌 waiting on Isaac's review @IsaacMilarky
Next time site will update is next Monday so get in code.json added to metrics, DedupliFHIR, /open, repo-scaffolder