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

filename prefixes don't follow PhET conventions #404

Closed
pixelzoom opened this issue Sep 18, 2017 · 4 comments
Closed

filename prefixes don't follow PhET conventions #404

pixelzoom opened this issue Sep 18, 2017 · 4 comments

Comments

@pixelzoom
Copy link
Contributor

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.

@samreid
Copy link
Member

samreid commented Sep 19, 2017

Fixed in the preceding commits. @pixelzoom or @jonathanolson do you want to review?

@jonathanolson
Copy link
Contributor

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.

@jonathanolson jonathanolson removed their assignment Sep 19, 2017
@pixelzoom
Copy link
Contributor Author

pixelzoom commented Sep 19, 2017

CCKC looks good.

@samreid To clarify... Does BlackBoxQueryParameters contain query parameters that are specific to a screen named "Black Box"? Or are they specific to a sim? I've never seen a *QueryParameters.js file that is screen-specific. (I tried to run circuit-construction-kit-black-box-study_en.html, but it fails at startup.)

@pixelzoom pixelzoom assigned samreid and unassigned pixelzoom Sep 19, 2017
@samreid
Copy link
Member

samreid commented Sep 19, 2017

I will rename BlackBox*.js to CCKBBS*.js in phetsims/circuit-construction-kit-black-box-study#61.

Does BlackBoxQueryParameters contain query parameters that are specific to a screen named "Black Box"? Or are they specific to a sim?

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.

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

3 participants