Update documentation to use `cisagov/gh-skeleton`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- github
- Domain
- documentation
Research direction
Start with project_setup/skeletonize-existing-repository.md and project_setup/README.md, then search the documentation for project_setup/scripts/skeleton and manual setup instructions. Update the affected guidance to reference the cisagov/gh-skeleton plugin or the repository-root setup-env script, and verify that no outdated setup references remain.
Written by the indexing model from the issue text.
Description
🐛 Summary
In some places this documentation still uses the old script that used to exist at project_setup/scripts/skeleton or includes instructions on how to set this up manually. The documentation should instead refer to the cisagov/gh-skeleton plugin for the gh GitHub CLI, or possibly the setup-env script at the repository root.
Examples of files that need to be updated are project_setup/skeletonize-existing-repository.md and project_setup/README.md.
- Dominant language
- Python
- Stars
- 282
- Forks
- 72
- 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.
More from cisagov/development-guide
-
documentation improvement
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
cisagov/development-guide#100 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
cisagov/development-guide#58 · 1 reaction ·
-
documentation improvement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cisagov/development-guide#51 · 1 reaction ·
-
improvement
Difficulty 5/5 Over a week Newbie friendliness 35/100
cisagov/development-guide#126 · 1 comment ·
-
improvement
Difficulty 4/5 3-5 days Newbie friendliness 25/100
cisagov/development-guide#112 · 1 reaction ·
All issues in cisagov/development-guide
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100