fermi-ad / parameter_page_app

Web application implementing the Parameter Page.
MIT License
4 stars 1 forks source link

Use kabob case for repo name #50

Open beauremus opened 1 year ago

beauremus commented 1 year ago

For consistency, we should use kabob case for the repo name. I think all our other repos are kabob case and it's the default for GitHub.

beauremus commented 1 year ago

By kabob case, I mean to use hyphens between words. parameter-page-app rather than snake case with underscores parameter_page_app.

cnlklink commented 1 year ago

Will this conflict with the requirement Flutter has that the working directory use underscores instead of hyphens? I think that's why @rneswold chose this name.

rneswold commented 1 year ago

Good question. @beauremus is only suggesting renaming the repo name, though.

beauremus commented 1 year ago

Do you have documentation on the working directory requirement? I can't seem to find it. A workaround is that git allows you to name your directory anything you want.

cnlklink commented 1 year ago

Sorry, it's a Dart package name requirement not a Flutter requirement. Although, if you do flutter create new-flutter-project you'll get an error:

PS C:\Users\jdiamond\Desktop\Workspace> flutter create new-flutter-project
"new-flutter-project" is not a valid Dart package name.

See https://dart.dev/tools/pub/pubspec#name for more information.

This is an annoying inconsistency.

cnlklink commented 1 year ago

What we could do is make the repo parameter-page and inside the repo a directory parameter_page_app?

beauremus commented 1 year ago

I found suggestions to use flutter create like this flutter create --project-name=t_t t-t.

In my experience, tools like flutter create munge this for you automatically. So, if everyone else is comfortable recommending flutter create --project-name=parameter_page parameter-page then that seems like the solution to me.

beauremus commented 1 year ago

Can we assume this restriction is to avoid parsing ambiguous minus signs? Otherwise, this seems needlessly restrictive. Also, I'm pretty sure other languages get around this...

cnlklink commented 1 year ago

I think what they're trying to achieve consistency in naming too (on pub.dev) - it's just opposite of our convention!