-
Notifications
You must be signed in to change notification settings - Fork 26.6k
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
Branding #263
Comments
It could have the AirBnB logo and a simple slogan like “coded in JavaScript style”You've got great designers out there, telling by https://www.airbnb.com :) |
I do believe "JS Standard Code Style" should be used here instead of the other one which actually is "JS Opinionated Code Style" |
Interesting. I wonder if it'd be nice to make a general style badge that's extensible in a way so it's easy to tell based on the readme what style the repo follows whether it's Airbnb, Crockford, jQuery, idiomatic or Standard. I want to think about this some more and will try to follow up later this week. |
@hshoff, one option is to use http://shields.io/:
@nkbt how about naming it “Quality JS code style” IMO “airbnb” isn't a name which conveys a meaning. Using “JS Standard” code style feels cool – like it's the right thing to do. But using “google” code style, “airbnb” code style, “facebook” code style – or whatever – feels dull. There's no feeling behind it, no subconcious association.
Think about it: – doesn't that feel reassuring? |
By the way, the NPM package quality is free :) Whether we just want to put the readme there, or a zero-conf tool like http://npm.im/standard. |
@tomekwi, agree, using Airbnb in a shield tells almost nothing how "much standard" it is. And it apparently is the most standard code style according to different code style surveys.
@gaearon, what do you think? |
@goatslacker I know this is your brand's color. But it looks like red, and red in a badge has a bad connotation. How about a neutral blue – the same http://shields.io uses for stable semver version numbers? It also stands out nicely. See for yourselves. |
@nkbt agreed – but airbnb/javascript is more than a code style guide. It's a mixture of best practices, explanations, benchmarks and code style. So using |
I'd be wary of any adjectives. I don't think right answer to If we have any actual data proving this is the most widespread style, I'd be tempted to call it |
Seems reasonable – looking at http://sideeffect.kr/popularconvention/#javascript, it seems like |
@goatslacker @hshoff @nkbt @gaearon, here’s my suggestion – to keep the discussion going: |
And another variation – “compatible” with the current repo name, so to speak: |
Here's a screenshot of our branding from http://airbnb.io |
@justjake love |
👍 to that as well! It’s a longish name, but way better than “airbnb style”. The problem with “airbnb style” is simple. The name is no longer valid when you fork the project. And it looks like forking is common and encouraged. |
should we rebrand to |
The Mostly Reasonable Guide to Writing JavaScript Like a Boss or TMRGTWJSLAB for short. |
@justjake: 👍 Personally, I like |
I took a look at Standard Plus and considered forking their stuff to copy the standard interface. It seems pretty easy to do, but I personally have low interest in taking on that work in my spare time. |
It's crazy easy, I will gladly do it. It just uses eslint. Although, it would be nice first if we:
|
You don't know me at all, but as someone who is interested in a code convention or style... to me the "Standard Code Style" made me feel that it was what I was looking for. Made me feel secure and comfortable, the one. So I vote for it. Also I agree with all the rules proposed on it so.. |
We were discussing this in #455 (comment), here's the quick recap: We started by talking about the name/branding of the package (related to #263) and @ljharb brought up the wonderful idea of using scoped npm packages. So the one-liner command would become: npm install @airbnb/javascript --save-dev Hopefully scoped packages catches on so if your team (Super Cool Co.) forks the guide and publishes your own package it would be: npm install @supercoolco/javascript --save-dev Which I think is a nice benefit of the scoped package route and encourages teams to use our guide as a starting point for their team's style guide.
|
Oh, thanks hshoff |
Fair enough! Good to have this thing closed. 😃 |
Hm. Why this popped up in my notifications, huh? Anyway. Just to join the thread with few words - i already added badges |
Make sense. But why purple? ;d The only reason i set it to bright green is consistency on the first line of my badges - trying always to be green (code style, build, codecov, deps). |
Because that's the purple that eslint uses was my thinking. All of my badges are already not the same color so I figured I'd pick something that has some meaning. |
This is the way to go folks: Here's the code: [![Code Style](https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript) You can thank @amio for this one! 😄 |
This comment has been minimized.
This comment has been minimized.
Yup, i'm already using that color in few places. Adding it next to the Btw, there is also an logo :P Append https://badgen.net/badge/style/Airbnb/ff5a5f?icon=airbnb |
@olstenlarck and i've updated yours to use the correct capitalization of Airbnb (never AirBnB) |
Hm, didn't know that, thanks. |
What I like about JS standard is not only its simplicity (no config), but also branding. But Standard is just a bunch of opinions – it's far from this guide in terms of comprehensiveness.
But yes, I'm a visual thinker – and I do buy stuff by their looks :) But I guess so do many other developers and designers. Just as a good readme with a green travis badge looks reassuring, so does a well-known logo.
How about developing something similar to this:
The text was updated successfully, but these errors were encountered: