overmindbots / core

Core monorepo with our apps and packages
1 stars 0 forks source link

Package naming convention #116

Open RafaelVidaurre opened 6 years ago

RafaelVidaurre commented 6 years ago

I feel like we need a better naming convention for our packages. What do you think about this as a first approach?

We prefix our packages with the app type and name The two kind of app types we currently make are web apps and bots:

Prefixes:

Examples:

We also have shared packages that do not belong to any app:

Prefixes:

Examples:

We also have packages that are specific to an app, so we prefix their name with the app's name. Examples:

Note: we can probably also configure our repo to have app folders with all the related packages inside to have less visual noise

monitz87 commented 6 years ago

The idea seems good, but what happens when we have a web app that is related to a bot? For example, the invite wrapper endpoint I’m currently working on. Would it be named bot-referral-ranks-app-invite-wrapper? Kind of verbose