lincc-frameworks / lincc-frameworks/python-project-template
Option to overwrite project README when hydrating
Nobody has claimed this yet.
- Dominant language
- Jinja
- Stars
- 85
- Forks
- 16
- Avg merge
- 6h 18m
- Merged PRs (30d)
- 1
Description
"Oh no! It does this thing where it doesn't overwrite the readme, and we do a lot of badges and things in there. We should change that," @delucchi-cmu says, while hydrating desi-aap for the incubator.
I agree--if you're hydrating a fresh github repo, there's a good chance you clicked the option to create a blank README, so it'd be really nice to have it replaced with something more useful.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start at the template hydration path and inspect how an existing blank GitHub README is detected or preserved. Done means hydration can replace that README with the more useful project README, while the default behavior and the overwrite option are covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100