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

Package naming conventions #6

Open
joekrill opened this issue Aug 2, 2019 · 1 comment
Open

Package naming conventions #6

joekrill opened this issue Aug 2, 2019 · 1 comment

Comments

@joekrill
Copy link
Contributor

joekrill commented Aug 2, 2019

It looks like we're going to have at least 2 "types" of packages within the repo: "utility" packages mainly used for internal use (i.e. eslint-config, build-tools) and actual UI packages that expose components for external consumption (i.e. core, icons). I'm not sure where storybook falls here, it's mostly internal but could eventually fall into a 3rd category if we publish it somewhere for reference.

So right now we end up with something like this:

.
|-- packages
|   |-- build-tools
|   |-- core
|   |-- eslint-config
|   |-- icons
|   `-- storybook

Should we consider prefixing either all, or certain types of these packages? For example, rename core and icons to ui-core and ui-icons (or some similar prefix)?

.
|-- packages
|   |-- build-tools
|   |-- eslint-config
|   |-- storybook
|   |-- ui-core
|   `-- ui-icons
@laurapear
Copy link

I like that idea. Another option (if this is a possibility) would be to put UI and utilities in their respective subfolders.

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