UCL-ARC / UCL-ARC/python-tooling
Applying the cookiecutter on an existing repo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 62
- Forks
- 10
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 6
Description
Is Your Feature Request Related to a Problem? Please Describe
When @samcunliffe and I had to apply a cookiecutter to an existing repo, we ended up creating the template on a separate directory and copying files across. Is there a better way to do this? And should we document this usecase in this repo?
@matt-graham mentioned that in the ARC festival workshop they tried a different approach to keep the git history.
Describe the Solution You'd Like
Mention this case in the readme and add some steps with the best way to do this.
Describe Alternatives You've Considered
No response
Additional Context
No response
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.
Research direction
Review the README and the existing issue discussion, then compare the approach used in the ARC festival workshop for applying a cookiecutter while preserving Git history. Document the recommended workflow for applying the template to an existing repository, including steps for the reported use case; done when a newcomer can follow the README without copying files manually.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100