Update README.md (#4415)

.github/CONTRIBUTING.md

@@ -15,27 +15,7 @@ Applied Energistics 2 crashing, have a suggestion, found a bug?  Create an issue
     * If it is already possible with vanilla and AE2 itself, the suggestion will be considered invalid.
     * Asking for a smaller version, more compact version, or more efficient version of something will also be considered invalid.
 2. Go to [the issues page](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues) and click [new issue](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues/new)
-3. Enter your a title of your issue (something that summarizes your issue), and then create a detailed description of the issue.
+3. If applicable, use on of the provided templates. It will also contain further details about required or useful information to add.
-    * Do not tag it with something like `[Feature]`, `[Bug]`, or a version.
-    * Restrict it to a single bug or feature, it makes managing them way easier for us.
-    * The following details are required. Also refer to the issue template when creating one.
-        * Forge version
-        * AE2 version
-        * Crash log, when reporting a crash (Please make sure to use [pastebin](http://pastebin.com/))
-            * Never post an excerpt of what you consider important
-            * Always post the full log
-        * Other mods and their version, when reporting an issue between AE and another mod
-            * Also consider updating these before submitting a new issue, it might be already fixed
-        * A detailed description of the bug or feature
-    * To further help in resolving your issues please try to include the follow if applicable:
-        * What was expected?
-        * How to reproduce the problem?
-            * This is usually a great detail and allows us to fix it way faster
-        * Server or Single Player?
-        * Screen shots or Pictures of the problem
-        * Mod Pack using and version?
-            * Keep in mind that some mods might use an outdated version of AE2
-            * If so you should report it to your modpack
 4. Click `Submit New Issue`, and wait for feedback!
 
 Providing as many details as possible does help us to find and resolve the issue faster and also you getting a fixed version as fast as possible.
@@ -47,17 +27,19 @@ Please note that we might close any issue not matching these requirements.
 * Submit an issue to the github project, assuming one does not already exist.
   * Clearly describe the issue including steps to reproduce when it is a bug.
   * Make sure you fill in the earliest version that you know has the issue.
+  * Waiting for feedback is suggested.
 * Fork the repository on GitHub
 * Create a topic branch from where you want to base your work.
-  * This is revison branch that is under active development.
+  * This `master` branch that is under active development.
   * Only target release branches if you are certain your fix must be on that
     branch.
   * To quickly create a topic branch based on the development branch; `git 
-    checkout -b fix/master/my_contribution branch`. Please avoid working 
+    checkout -b my_contribution_branch`. Please avoid working 
-    directly on the `active development` branch.
+    directly on the `master` branch.
 * Make commits of logical units.
 * Check for unnecessary whitespace with `git diff --check` before committing.
 * Make sure your commit messages are in the proper format.
+  * You can either use the gradle `spotlessCheck` and `spotlessApply` tasks or use the provided eclipse formatter config in `/codeformat`
 
 ````
     (#12345) Make the example in CONTRIBUTING imperative and concrete
@@ -72,20 +54,18 @@ Please note that we might close any issue not matching these requirements.
     from our issue tracker.  The body describes the behavior without the patch,
     why this is a problem, and how the patch fixes the problem when applied.
 ````
-* Always fully test your changes. If they are large engouh in scope, then fully test AE2.
+* Always fully test your changes. If they are large enough in scope, then fully test AE2.
 * Describing the process you used to test your changes in detail will help speed up this process.
 
 ## Making Trivial Changes
 
 ### Documentation
 
-For changes of a trivial nature to comments and documentation, it is not
+For changes of a trivial nature to comments and documentation, it is not always necessary to create a new issue. 
-always necessary to create a new issue. In this case, it is
+We usually use `squash and merge`. This allows us to easily append the PR number for future reference.
-appropriate to start the first line of a commit with '(doc)' instead of
-a ticket number.
 
 ````
-    (doc) Add documentation commit example to CONTRIBUTING
+    Add documentation commit example to CONTRIBUTING
 
     There is no example for contributing a documentation commit
     to the Puppet repository. This is a problem because the contributor
@@ -112,56 +92,11 @@ the styling guidelines used by AE.
 
 PRs that do not conform to these standards will be rejected.
 
-You can find presets for Eclipse and IntelliJ IDEA in the `codeformat` folder.
+You can find presets for Eclipse in the `codeformat` folder. For IntelliJ IDEA we recommend the eclipse formatter plugin.
-We try to keep them up to date. Please report any case of maintaining the correct formatting.
 
-### Whitespace
+There is also a gradle task available to check for syntax errors (`spotlessCheck`) as well as applying the fixes (`spotlessApply`).
 
-#### Tabs or spaces
+We try to keep them up to date. Please report any problem with maintaining the correct formatting.
-Configure your IDE to use tabs as padding whitespace. Ensure that there is no extra whitespace 
-at the end of lines, or on blank lines.
-
-#### Pad parenthes with whitespace
-````
-if( item.equals( newItem )
-
-public void DeleteItem( item )
-
-catch( Throwable )
-````
-
-### Braces
-
-Place opening and closing braces on a new line. Always include open and close braces, even if
-the body is a single line.
-
-````
-if( item.equals( newItem )
-{
-
-}
-else
-{
-
-}
-
-public void DeleteItem( item )
-{
-
-}
-````
-
-## Submitting Changes
-
-* Push your changes to a topic branch in your fork of the repository.
-* Submit a pull request to the repository in the puppetlabs organization.
-* Update your issue to mark that you have submitted code and are ready for it to be reviewed.
-  * Include a link to the pull request in the ticket.
-* The core team looks at Pull Requests on a regular basis.
-  * There are many reasons why it will take a long time to pull your PR. Be patient, we'll
-    get to it.
-* After feedback has been given we expect responses within two weeks. After two
-  weeks will may close the pull request if it isn't showing any activity.
 
 # Additional Resources
 

.github/ISSUE_TEMPLATE.md

@@ -1,16 +1,13 @@
-<!-- Provide a summary of the issue in the Title above, please do not "[Tag]" it -->
+<!-- Provide a summary of the issue in the Title above, please do not "[Tag]" it. -->
 
-#### Description
+**Describe the issue**
-<!-- Always use the most recent version from ae-mod.info, it might already be fixed -->
+<!-- Always use the most recent version from ae-mod.info, it might already be fixed. -->
-<!-- When describing a bug, tell us what was expected and what the actual behaviour is -->
+<!-- When describing a bug, tell us what was expected and what the actual behaviour is. -->
-<!-- When suggesting a feature, tell us how it should work and why it should be considered -->
+<!-- When suggesting a feature, tell us how it should work and why it should be considered. -->
 
-#### Environment
+**Environment**
 <!-- Include as many relevant details about the environment -->
-<!-- Like the used version, SP/MP, other mods and their version, crashlogs etc -->
+<!-- A forced crash report by pressing F3+c for 10 seconds. Use pastebin, gist, etc. -->
-<!-- Please use pastebin or gist for posting the complete crashlog, no excerpt -->
+<!-- Without it, we will automatically close the issue. -->
-<!-- The following ones are required, please note "latest" is not a version -->
 
-- Minecraft Version: 
+- Environment: 
-- AE2 Version: 
-- Forge Version: 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,9 +22,7 @@ about: You found a bug or encountered a crash? Please report it here.
 
 **Environment**
 <!-- Include as many relevant details about the environment -->
-<!-- Like the used version, SP/MP, other mods and their version -->
+<!-- A forced crash report by pressing F3+c for 10 seconds. Use pastebin, gist, etc. -->
-<!-- The following ones are required, please note "latest" is not a version -->
+<!-- Without it, we will automatically close the issue. -->
 
-- Minecraft Version: 
+- Environment: 
-- AE2 Version: 
-- Forge Version:

README.md

@@ -1,5 +1,5 @@
-[![Travis](https://img.shields.io/travis/AppliedEnergistics/Applied-Energistics-2.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/AppliedEnergistics/Applied-Energistics-2)
+[![Build master](https://img.shields.io/github/workflow/status/AppliedEnergistics/Applied-Energistics-2/Build master?style=flat-square)](https://github.com/AppliedEnergistics/Applied-Energistics-2/actions?query=workflow%3A%22Build+master%22)
-[![Latest Release](https://img.shields.io/github/release/AppliedEnergistics/Applied-Energistics-2.svg?label=Latest%20Release&style=flat-square)](https://github.com/AppliedEnergistics/Applied-Energistics-2/releases)
+[![Latest Release](https://img.shields.io/github/v/release/AppliedEnergistics/Applied-Energistics-2?label=Latest%20Release&style=flat-square)](https://github.com/AppliedEnergistics/Applied-Energistics-2/releases)
 
 # Applied Energistics 2
 
@@ -32,13 +32,13 @@ A Mod about Matter, Energy and using them to conquer the world..
 ## License
 
 * Applied Energistics 2 API
-  - (c) 2013 - 2018 AlgorithmX2 et al
+  - (c) 2013 - 2020 AlgorithmX2 et al
   - [![License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](http://opensource.org/licenses/MIT)
 * Applied Energistics 2
-  - (c) 2013 - 2018 AlgorithmX2 et al
+  - (c) 2013 - 2020 AlgorithmX2 et al
   - [![License](https://img.shields.io/badge/License-LGPLv3-blue.svg?style=flat-square)](https://raw.githubusercontent.com/AppliedEnergistics/Applied-Energistics-2/rv2/LICENSE)
 * Textures and Models
-  - (c) 2013 - 2018 AlgorithmX2 et al
+  - (c) 2013 - 2020 AlgorithmX2 et al
   - [![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%203.0-yellow.svg?style=flat-square)](https://creativecommons.org/licenses/by-nc-sa/3.0/)
 * Text and Translations
   - [![License](https://img.shields.io/badge/License-No%20Restriction-green.svg?style=flat-square)](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -59,27 +59,7 @@ Applied Energistics 2 crashing, have a suggestion, found a bug?  Create an issue
     * If it is already possible with vanilla and AE2 itself, the suggestion will be considered invalid.
     * Asking for a smaller version, more compact version, or more efficient version of something will also be considered invalid.
 2. Go to [the issues page](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues) and click [new issue](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues/new)
-3. Enter your a title of your issue (something that summarizes your issue), and then create a detailed description of the issue.
+3. If applicable, use on of the provided templates. It will also contain further details about required or useful information to add.
-    * Do not tag it with something like `[Feature]`, `[Bug]`, or a version.
-    * Restrict it to a single bug or feature, it makes managing them way easier for us.
-    * The following details are required. Also refer to the issue template when creating one.
-        * Forge version
-        * AE2 version
-        * Crash log, when reporting a crash (Please make sure to use [pastebin](http://pastebin.com/))
-            * Never post an excerpt of what you consider important
-            * Always post the full log
-        * Other mods and their version, when reporting an issue between AE and another mod
-            * Also consider updating these before submitting a new issue, it might be already fixed
-        * A detailed description of the bug or feature
-    * To further help in resolving your issues please try to include the follow if applicable:
-        * What was expected?
-        * How to reproduce the problem?
-            * This is usually a great detail and allows us to fix it way faster
-        * Server or Single Player?
-        * Screen shots or Pictures of the problem
-        * Mod Pack using and version?
-            * Keep in mind that some mods might use an outdated version of AE2
-            * If so you should report it to your modpack
 4. Click `Submit New Issue`, and wait for feedback!
 
 Providing as many details as possible does help us to find and resolve the issue faster and also you getting a fixed version as fast as possible.
@@ -91,17 +71,10 @@ Please note that we might close any issue not matching these requirements.
 1. Clone this repository via 
   - SSH `git clone git@github.com:AppliedEnergistics/Applied-Energistics-2.git` or 
   - HTTPS `git clone https://github.com/AppliedEnergistics/Applied-Energistics-2.git`
-2. Setup workspace 
+2. Build using the gradle `build` task. Jar will be in `build/libs`
-  - Decompiled source `gradlew setupDecompWorkspace`
+3. For core developer: Setup IDE
-  - Obfuscated source `gradlew setupDevWorkspace`
+  - IntelliJ: Import as gradle project
-  - CI server `gradlew setupCIWorkspace`
+  - Eclipse: Import as gradle project or execute gradle task `eclipse` and potentially `genEclipseRuns`
-3. Build `gradlew build`. Jar will be in `build/libs`
-4. For core developer: Setup IDE
-  - IntelliJ: Import into IDE, execute `gradlew genIntellijRuns` and change RunConfiguration to `*_main` as quickfix for [ForgeGradle](https://github.com/MinecraftForge/ForgeGradle/issues/357)
-  - Eclipse: execute `gradlew eclipse`
-5. For add-on developer: Core-Mod Detection
-  - In order to have FML detect AE from your dev environment, add the following VM Option to your run profile
-  - `-Dfml.coreMods.load=appeng.coremod.AppEngCore`
 
 ## Contribution