Permalink
Browse files

Update STYLE.md and add in editorconfig

  • Loading branch information...
1 parent bfa36bd commit 7f40113ba7fa66ebb66327024647f9e8085a81a7 @RyanTheAllmighty RyanTheAllmighty committed Feb 12, 2016
Showing with 25 additions and 11 deletions.
  1. +10 −0 .editorconfig
  2. +1 −0 .gitignore
  3. +14 −11 STYLE.md
View
@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = false
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+max_line_length=120
View
@@ -5,6 +5,7 @@
# Except These
!/src/
!/macapp/
+!/.editorconfig
!/.gitignore
!/CONTRIBUTING.md
!/CHANGELOG.md
View
@@ -1,33 +1,36 @@
-# ATLauncher Coding Standards & Styling Guidelines
+# ATLauncher coding standards & styling guidelines
+If you wish to submit a pull request to ATLauncher then please take a look at the below sections about our coding and
+styling standards before make said pull request.
-So if you wish to submit any Pull Requests, please follow these coding standards. Styling guidelines are just how I like
-to have things styled, mainly relating to doc blocks and comments.
+## Coding standards
+Coding standards are absolutely essential to having your pull request approved. While we may not close your pull
+request if it doesn't follow these coding standards, we most likely will delay merging it until compliant.
-## Coding Standards
-
-- Please keep all line lengths to 120 characters and use 4 spaces rather than tab characters.
+- Please keep all line lengths to 120 characters.
+- Please don't use tabs, use 4 spaced tabs.
- Please keep all variables at the top of the class.
- Please keep all inner classes at the bottom.
- Please don't use star imports.
- Please mark all classes that are to be de/serialized with Gson with the @Json annotation for other developers.
-- Please use the IntelliJ-Coding-Style.jar for the project (if using IntelliJ) in order to keep all formatting
-consistent.
- Please update the CHANGELOG.md file when fixing/adding something so it's easier to keep track of than git commits.
Feel free to add in a 'by MyUsername' to the end of the changes you've made.
- Please don't do large commits. My preference is a single commit for a single fix/addition rather than bundled up
commits.
- Please use final where possible.
- Please make sure all files contain the GNU GPLv3 license at the top of the file.
-## Styling Guidelines
+## Styling guidelines
+Styling guidelines are just how we prefer to have things styled, mainly relating to doc blocks and comments. Not
+following these guidelines will not get your pull requests denied as they're less important than our actual coding
+standards listed above.
- Make sure all doc block information has a full stop at the end.
- Make sure all doc block @ elements don't have a full stop at the end.
-- Make sure all comments not in doc blocks end in a full stop.
+- Make sure all comments not in doc blocks don't have a full stop at the end.
- Make sure there is a blank line between any main doc block information and any @elements.
### Example
- // Some comment. Which ends in a full stop.
+ // Some comment. Which doesn't end in a full stop
/**
* Where the magic happens. Notice I end in a full stop.

0 comments on commit 7f40113

Please sign in to comment.