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

Docs: Include paragraph about SCREAMING_SNAKE_CASE constants (JS) #5819

Merged
merged 1 commit into from
Jun 6, 2016

Conversation

aduth
Copy link
Contributor

@aduth aduth commented Jun 6, 2016

Related: #5743 (comment)

This pull request seeks to add a paragraph to our JavaScript coding standards about the use of "screaming snake case" naming convention for constant values. This naming convention is already quite widespread in the application, but is not documented.

Testing instructions:

No application changes included.

Ensure that the paragraph and example are readable and the use of "screaming snake case" (a term I'd not seen used previously) is well-understood.

/cc @timmyc @mtias @nb

@aduth aduth added Documentation Framework [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. labels Jun 6, 2016
@timmyc
Copy link
Contributor

timmyc commented Jun 6, 2016

While I was going to try and use Snakes on a Plane to make a joke here, it is early Monday, and I have yet to consume the requisite quantity of coffee to do so. But the doc changes LGTM.

@timmyc timmyc added [Status] Ready to Merge and removed [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. labels Jun 6, 2016
@aduth
Copy link
Contributor Author

aduth commented Jun 6, 2016

While I was going to try and use Snakes on a Plane to make a joke here

Screaming snake case? https://www.youtube.com/watch?v=amYzBQMT4VI

@gwwar
Copy link
Contributor

gwwar commented Jun 6, 2016

snakes

@nb
Copy link
Member

nb commented Jun 6, 2016

👍

@aduth
Copy link
Contributor Author

aduth commented Jun 6, 2016

Thanks for the reviews (and suitably appropriate gif @gwwar 😆 )

@aduth aduth merged commit fb74a4d into master Jun 6, 2016
@aduth aduth deleted the update/docs-js-upper-case-constants branch June 6, 2016 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants