From 2bf6d447785a0fe642bfa3e0ed061022a7de090e Mon Sep 17 00:00:00 2001 From: Erik Erikson Date: Thu, 22 Sep 2016 12:28:35 -0700 Subject: [PATCH 1/2] Add Initial .editorconfig File Editor config allows IDEs to consistently behave according to the project's proscribed formatting requirements. This means that fewer spurious white space changes will be committed and that fewer generated white space characters will have to be eliminated by individual developers whose defaults are different than those of the Serverless project. --- .editorconfig | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..49dafa5e2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true ; top-most EditorConfig file + +; Unix-style newlines with a newline ending every file +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true From 1b0e9aed6bb779a01ecf2b47b1f61face270a087 Mon Sep 17 00:00:00 2001 From: Erik Erikson Date: Thu, 22 Sep 2016 12:28:35 -0700 Subject: [PATCH 2/2] Add Initial .editorconfig File & Docs Editor config allows IDEs to consistently behave according to the project's proscribed formatting requirements. This means that fewer spurious white space changes will be committed and that fewer generated white space characters will have to be eliminated by individual developers whose defaults are different than those of the Serverless project. --- .editorconfig | 10 ++++++++++ CONTRIBUTING.md | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..49dafa5e2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true ; top-most EditorConfig file + +; Unix-style newlines with a newline ending every file +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08c2f8a9d..6f90de2d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ Please follow these Issue guidelines for opening Issues: * Make sure your Issue is for a *feature request*, *bug report*, or *a discussion about a relevant topic*. For everything else, please use our [Discourse Forum](http://forum.serverless.com) ### Code Style -We aim for clean, consistent code style. We're using ESlint to check for codestyle issues using the Airbnb preset. If ESlint issues are found our build will fail and we can't merge the PR. +We aim for clean, consistent code style. We're using ESlint to check for codestyle issues using the Airbnb preset. If ESlint issues are found our build will fail and we can't merge the PR. To help reduce the effort of creating contributions with this style, an [.editorconfig file](http://editorconfig.org/) is provided that your editor may use to override any conflicting global defaults and automate a subset of the style settings. You may need to enable EditorConfig's use by changing a setting or installing a plugin. Using it is not compulsory. Please follow these Code Style guidelines when writing your unit tests: * In the root of our repo, use this command to check for styling issues: `npm run lint`