diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b2dadf3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 2 diff --git a/README.md b/README.md index 21e8058..68053c1 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,8 @@ Check out what's been added but not yet releases at [develop.getpapercss.com](ht This project is open source and contributions are very welcomed. It is also as beginner friendly as possible, so don't be afraid to jump in if you've never contributed to any Git project before! Feel free to reach out if you are new and need help with the process. +Please before sending a PR, make sure you are using the `.editorconfig` file with your IDE. If your IDE doesn't natively support editorconfig files, you can use an extension. For example in Atom there is the [editorconfig package](https://atom.io/packages/editorconfig), as well for [Sublime](https://github.com/sindresorhus/editorconfig-sublime), [VS Code](https://github.com/editorconfig/editorconfig-vscode), [Vim](https://github.com/editorconfig/editorconfig-vim), ... + Similar to customizing, make sure you have Git, Node, and NPM on your system. - fork the repo via the fork button in the upper left - run `git clone https://github.com/[your_username]/papercss.git`