-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
priority: lowThe issue/PR is low priority—not many people are affected or there’s a workaround, etc.The issue/PR is low priority—not many people are affected or there’s a workaround, etc.type: enhancementThe issue is a request for an enhancement.The issue is a request for an enhancement.
Description
This is kind of a follow up from #6 (comment)
User story
It's rather a cosmetic 💅 problem, but I think it'd be nice to settle on good names, as later it could be hard to ever them.
As a user of Grow tools, I'd like to write less code/configs/ etc. and avoid repetition.
Also when it comes to the package name.
Is your feature request related to a problem?
Currently, we use a format of woocommerce-grow-{package-name} for our tools here. (As it was introduced in the very first package)
It has a set of benefits:
- states the full product name, probably good for recognition
- states the team name, so it's distinct from Woo-wide tools
- does not use shorthand which makes it kind of disambiguous, and readable out loud 1:1 in plain English
But I have a doubt, whether it's not too long. Especially, when the package name adds up, and the name is used not only in package.json's devDependencies, but also in some other files, like configs, like:
- Some tags in .md files
<woo-tracking-jsdoc></woo-tracking-jsdoc> - Commands in
package.json'sscriptswhich to be fully consistent would be renamed to:"storybook": "woocommerce-grow-storybook", "storybook:build": "woocommerce-grow-storybook build", "storybook:deploy": "woocommerce-grow-storybook deploy", - Config files as mentioned in Add tracking JSDoc template and plugins. #6 (comment) (however having that config file is a matter of another discussion)
Describe the solution you'd like
I see a few ways to go:
- Don't make any hard rule and decide ad hoc for every case separately, the package name, the config references, the binaries' names, element names etc.
- Make
woocommerce-grow-{package-name}for every package reference - Use something shorter, like
woo-grow-{package-name}- Use it everywhere
- Use a long name for packages, a short name for any references
For woo-grow- I could list a few benefits
- shorter
- is well-coined shorthand
- Does not necessarily reference the WooCommerce product, but rather the Woo division. And we may have some tools not just for WooCommerce per see, but for some other needs. I cannot think of a good example now - maybe something like
woo-grow-ping-porterCLI/slack command. Also Grow is not a part of WooCommerce plugin, but rather Woo as an organization. - States a clear distinction between those packages and
woocommercepackages. - "Iswoocommerce-grow-upa WooCommerce's "grow-up" package, or WooCommerce Grow'suppackage?"
Unknowns
Out of bounds/rabbit holes
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
priority: lowThe issue/PR is low priority—not many people are affected or there’s a workaround, etc.The issue/PR is low priority—not many people are affected or there’s a workaround, etc.type: enhancementThe issue is a request for an enhancement.The issue is a request for an enhancement.