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

🏗 Add .editorconfig #18401

Merged
merged 1 commit into from
Nov 13, 2018
Merged

Conversation

westonruter
Copy link
Member

What is EditorConfig?

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.

Contributors to AMP will benefit from having an EditorConfig in that they will be less likely to submit PRs that contain incorrect code style since many editors automatically configure themselves based on this file when present.

The default config should help code conform to the Google JavaScript Style Guide. Markdown files get an exception for trim_trailing_whitespace since GitHub uses trailing two spaces to insert a newline.

@westonruter
Copy link
Member Author

/cc @rsimha

Copy link
Contributor

@rsimha rsimha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Is there a well known list of IDEs that use / don't use this file? never mind, just saw the list in the description.

@westonruter westonruter changed the title ✨ Add .editorconfig 🏗 Add .editorconfig Sep 27, 2018
@erwinmombay
Copy link
Member

is this mergeable?

@rsimha rsimha merged commit e2b0aaa into ampproject:master Nov 13, 2018
Enriqe pushed a commit to Enriqe/amphtml that referenced this pull request Nov 28, 2018
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