-
Notifications
You must be signed in to change notification settings - Fork 10
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
filename prefixes don't follow PhET conventions #404
Comments
Fixed in the preceding commits. @pixelzoom or @jonathanolson do you want to review? |
I didn't flag this in my code review, as it's something I've also done. I'd prefer @pixelzoom reviews due to that. |
CCKC looks good. @samreid To clarify... Does |
I will rename BlackBox*.js to CCKBBS*.js in phetsims/circuit-construction-kit-black-box-study#61.
They are for the "Circuit Construction Kit: Black Box Study" sim, which was nicknamed as Black Box for some of the filenames, which will be fixed in phetsims/circuit-construction-kit-black-box-study#61. |
This issue applied to both circuit-construction-kit-common and circuit-construction-kit-black-box-study.
The convention for filename prefixes is to use either the full name of the repository, or the abbreviated acronym for the repository. E.g for expression-exchange, we would have either ExpressionExchangeConstants.js or EEConstants.js. The choice is up to the developer, should be applied consistently, and should not duplicate an abbreviation that is already used by another repository.
circuit-construction-kit-common and circuit-construction-kit-black-box-study don't use either convention. circuit-construction-kit-common uses the prefix "CircuitConstructionKit", while circuit-construction-kit-black-box-study uses the prefix "BlackBox". If verbosity is the issue, they could use "CCKC" and "CCKBBS" respectively.
I don't know if this was flagged in code review.
The text was updated successfully, but these errors were encountered: