-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Applying the cookiecutter on an existing repo #416
Comments
Should it be on the website too? Perhaps a bit out of scope: the website is "just" recommending tools, the root-level README is instructions for how to use the cookie-cutter template. |
Do we know if this is a common use-case? Obviously, it would be very handy, but perhaps out of scope? Would be good to document either way, perhaps the website could have a |
In the workshop we worked on applying the cookiecutter package structure to the existing package in zmek/patientflow. We initially tried following a Some thoughts / comments on doing this for this specific case:
|
FWIW https://cruft.github.io/cruft/ might be of interest, which I've seen used for exactly this elsewhere (https://github.com/OpenAstronomy/packaging-guide) |
Just FYI @matt-graham, one big advantage of having all |
From an RSECon24 workshop: copier does seem to deal with this nicely, as it allows you to apply the template to an existing project. Some other interesting features:
One downside may be that it abstracts away too much for beginners. It seems better to gradually increase complexity, rather than abstract everything away from the start. But they do have the option to add selected features, which is maybe more aligned with that second approach. Relatedly, the neuroinformatics team pointed me to a guide Laura did a while ago on how to use cruft to apply a cookiecutter template to an existing repo. |
Should we just point to Laura's guide? |
I have no opinions or useful advice other than I've seen cruft being used before 😄 |
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
The text was updated successfully, but these errors were encountered: