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

Migrate to a cookiecutter template #11

Open
kieran-ryan opened this issue Jun 19, 2023 · 0 comments
Open

Migrate to a cookiecutter template #11

kieran-ryan opened this issue Jun 19, 2023 · 0 comments
Labels
⚡ enhancement New feature or request

Comments

@kieran-ryan
Copy link
Owner

"cookiecutter" is a Python-based command-line utility that facilitates project creation using customisable project templates. These templates allow users to input predefined configuration options for their projects. By defining configurable elements within the template, template owners can guide users in modifying the initial project according to their needs.

However, there is a tradeoff when using "cookiecutter" with GitHub templates. The top level of the repository contains the "cookiecutter" scaffold, which includes the template directory and supporting infrastructure, rather than solely the template directory. Additionally, the files within the template directory include template-engine logic that applies user-entered configurations when generating the project. As a result, the template is not in a usable state if someone tries to create a new project using the GitHub UI. Substantial modifications would be required to make it functional.

Consideration should be made to migrate to "cookiecutter". Although, if the template serves a broader purpose and there is limited value in providing configuration options, it may be more desirable to continue support for project creation through the GitHub UI.

@kieran-ryan kieran-ryan added the ⚡ enhancement New feature or request label Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚡ enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant