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

Choosing a good shortname, and making sure everything else has that same name #21

Open
boutell opened this issue Nov 4, 2016 · 2 comments

Comments

@boutell
Copy link
Member

boutell commented Nov 4, 2016

The "shortname" of your project, like "ccd" or "pogil" or "thenotebook", should also be the name of the repo, the name of the database, the name of the directory on the server (and on your hard drive), and the name of everything else that requires a unique name for the project. Do everything you can to avoid diverging on this point.

The shortname may contain lowercase letters, digits, and hyphens. Nothing else.

The shortname should be short, but consistency is even more important than brevity.

Also, if a project is "forked," for instance to create a full site from a placeholder site, and the placeholder site continues to be live in the meantime, the shortname / database name / everything name must be different for the fork. See https://github.com/punkave/best-practices/issues/20.

@boutell boutell changed the title shortname = repo name = database name = directory name = everything name (to bring them all and in the darkness .bind() them) Choosing a good shortname, and making sure everything else has that same name Nov 4, 2016
@austinstarin
Copy link
Contributor

I'm all for this!

@austinstarin
Copy link
Contributor

I'm going to tag this "to document" unless anyone opposes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants