diff --git a/README.md b/README.md index b213bb8122..e28320995f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Airbnb JavaScript Style Guide() { +# Present JavaScript Style Guide() { *A mostly reasonable approach to JavaScript* @@ -999,6 +999,32 @@ // ..stuff.. } ``` + + - Allow scope to imply context for names. Be sure to use meaningful names to differentiate items of similar nature. + + ```javascript + // bad + function sendMessageToUser(user1, user2) { + var date = Date(), + message = { + body: 'hey', + messageCreationDate: date + }; + + // ...stuff... + } + + // good + function sendMessageToUser(sender, recipient) { + var messageCreationDate = Date(), + message = { + body: 'hey', + creationDate: messageCreationDate + }; + + // ..stuff.. + } + ``` - Use camelCase when naming objects, functions, and instances