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

Incompatible Template implementation options #90

Open
moritztim opened this issue Nov 13, 2024 · 2 comments
Open

Incompatible Template implementation options #90

moritztim opened this issue Nov 13, 2024 · 2 comments

Comments

@moritztim
Copy link

Currently, this repository is set up as both a GitHub template repository and a cargo-generate template. This creates potential confusion and inconsistency in how users might initialize new projects.

There are currently two approaches to using this template and they are incompatible:

  • The cargo-generate approach is not documented anywhere in this repository
  • Users can create repositories directly through GitHub's template feature
  • Cargo-generate doesn't seem to support with an already created repository, instead assuming you'll be creating a repository from scratch

Both have drawbacks:

  • The GitHub template approach requires manual configuration changes, making it more error-prone and less approachable
  • The cargo-generate approach isn't integrated with GitHub the way GitHub templates are (i.e. you can't see that this is a template and that a repository is based on it)

However, I believe that the drawbacks of the github approach are more significant and the original intended use seems to be through cargo-generate, so I suggest disabling the template setting on this repository and adding instructions to the readme.

This would provide a clearer, more maintainable path for users to create new projects based on this template.

Disclaimer: I used Anthropic's Claude LLM to provide a starting point for the structure for this issue.

@9names
Copy link
Member

9names commented Nov 13, 2024

This is an incorrect read of the history of this template.
The original intended method for using this template was cloning the repo or downloading it using the github download as zip button.
Later we added the GitHub template option.
Later than that we added cargo-generate support (once that tool was stable enough).

The intention is for this to work whichever way the end-user tries, so we don't have to force any specific tooling on them.

@moritztim
Copy link
Author

I see. In that case, to minimize confusion, the cargo-generate support needs to be documented somewhere so users know that it's available and know that if they're not using it, they should remove it, as it's not really a part of the template if used in that way.

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