search

Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
1 stars 8 forks source link

Decide names for cookiecutter.json parameters #40

Closed Sparks29032 closed 3 months ago

sbillinge commented 3 months ago

Please start with my suggestions from before and make suggestions.

As I understand it, the cookiecutter just lists the variable name and the default value. There is no "help" message. The way NSLS-II is using it they either specify the default as a kind of de facto help, e.g., "name or organization" to "full_name" or else they suggest an actual default, so package directory inherits package name by default.

I feel it would be better in the long run to have longer variable names that convey a bit of the "help" and keep the defaults for reasonable defaults.

Thoughts?

sbillinge commented 3 months ago

to expand on that, what the cookiecutter uses the first variable "full_name" for is the org in the URL, so I think better would be "github_org" for the variable name and either "billingegroup" or "diffpy" as the default (not sure if we will be making more diffpy or more billingegroup packages in the future).

Something like that?