Provide instruction about the .editorconfig

This commit is contained in:
NotMyFault 2021-05-20 00:26:35 +02:00
parent 9c59bfde52
commit c48559410f
No known key found for this signature in database
GPG Key ID: 158F5701A6AAD00C

View File

@ -2,8 +2,7 @@
If you feel like you can improve the plugin any way, then you are more than welcome to contribute to PlotSquared. It would be highly appreciated if you made sure to test your code before committing it, as it will save us a lot of time and effort. If you feel like you can improve the plugin any way, then you are more than welcome to contribute to PlotSquared. It would be highly appreciated if you made sure to test your code before committing it, as it will save us a lot of time and effort.
### Code Style ### Code Style
If you are planning to commit any changes to the project, it would be highly appreciated if you were to follow the project code style conventions. To make this easier we have provided settings that can be imported into your IDE. If you are planning to commit any changes to the project, it would be highly appreciated if you were to follow the project
code style conventions. To make this easier we have provided settings that can be picked up by your IDE.
Eclipse: `Window > Preferences > Java > Code Style > Formatter` Press `Import` and select `...path/to/project/code_style.xml` IntelliJ: Install the `EditorConfig` plugin. Now IntelliJ is able to pick up the provided `.editorconfig` file automatically.
IntelliJ: `File > Settings > Editor > Code Style`. Next to "Scheme" there is a cog wheel, press that and then `Import Scheme > IntelliJ IDEA Code Style XML` and then select `..path/to/project/code_style.xml`