Skip to content
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

use cookicutter + "template" branch to UX in creation and upgrades #42

Open
yarikoptic opened this issue Aug 29, 2022 · 1 comment
Open

Comments

@yarikoptic
Copy link
Member

  • templating: instead of "Replace hello_cmd with the ..." etc, make this project into https://github.com/cookiecutter/cookiecutter template. Users then should be able to just enter the name and all the fields would be filled in
  • upgrades: Analogous how datalad-crawler establishes incoming branch different from master, and how we established "3rd" branch in other projects for "vanilla" 3rd party code, and reflecting on such recommended practice in How to update a project with changes from its cookiecutter? cookiecutter/cookiecutter#784 (comment)
    • in this repo use cookiecutter branch
    • adjust README.md to say that actual extension project should checkout master main (or whatever they want) from that cookiecutter branch to introduce any changes beyond cookiecutter config etc. Then for upgrades - checkout cookiecutter, re-cut, and merge into main.

there is also https://cruft.github.io/cruft/ which might be doing both of the above. Yet to check it out to see if worth using it instead of tandem above.

@ypid-work
Copy link

Checkout Copier before deciding how to rework this template. https://copier.readthedocs.io/en/stable/comparisons/

I am using Copier for a few years already and can recommend it. But I must say I have no experience with cookicutter so I don’t know how cookicutter developed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants