Code-gov Improvements: Agency Cards and Tests
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- github-actions, javascript
- Domain
- documentation, full-stack, testing
Research direction
Start with the failing GitHub Actions run and review the scripts directory to determine whether agency-index files are still fetched and created. Inspect the agency-indexes directory and the agencies tab implementation before adding unit tests and documentation. Done means backend tests pass, data processing is documented, and each agency card links to its agency-index.json and shows the correct project count, full name, and description.
Written by the indexing model from the issue text.
Description
MENTOR
- @natalialuzuriaga, @decause-gov
- Software Engineer, CMS OSPO, code-gov inventory
- #dsac-ospo on Slack
BRIEF DESCRIPTION
Backend
The backend is powered by scripts triggered by GitHub Actions: https://github.com/DSACMS/code-gov/tree/main/scripts. Currently, these scripts are failing: https://github.com/DSACMS/code-gov/actions/runs/29187121813/job/86635160396. Please review the code and its functionality, and see whether it is still fetching and creating the agency-index files: https://github.com/DSACMS/code-gov/tree/main/agency-indexes. Write unit tests to ensure it is working.
Frontend
We would like to add the following information for each agency card in the agencies tab:
code.json: placeholdershould be a link to the agency's agency-index.json found in https://github.com/DSACMS/code-gov/tree/main/agency-indexes- Ensure that
projects: ##count is correct - Include a full name and description of the agency in its agency card
SCOPING
- 2-3 days
SKILLS NEEDED
Full Stack, Documentation, Metadata, Testing
REQUIRED DELIVERABLES
-
Review backend. Create unit tests to ensure functionality. Write docs explaining data fetching and processing
-
Each agency card should have:
- Link to code.json link
- Project count
- Agency full name
- Description
NOTES/INSPO
Review with Remy on any other information to be added to code-gov!
ACKNOWLEDGEMENTS
- - 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
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·