Improve CONTRIBUTING.md

Author: Andre601

.github/CONTRIBUTING.md

@@ -35,21 +35,73 @@ We accept pull requests for fixing issues or adding new features, but you have t
 Please add javadocs comments to **all public methods the developer has access to.**  
 Javadocs help developers to see what methods they can/should use and what those do.
 
-When adding Javadoc comments, follow this template:  
+When adding Javadoc comments, follow this Styling choises.
+
+#### Line breaks and paragraphs
+When making a new line, start the new line with `<br>` and __don't__ close it.  
+For paragraphs, keep an empty line in between and then start the new line with a `<p>` (Also don't close it)
+
+**Example**:
 ```java
 /**
- * Short summary of what the method does. 
- * <br>Start new lines with a {@code <br>}
+ * This is a small summary of some method.
+ * <br>It uses line breaks like those.
  *
- * @param  bar
- *         Set the description in the new line.
+ * <p>But also new paragraphs are used.
+ */
+```
+
+#### Links
+When linking to other classes or methods, use the full path to it in the `{@link}` option.
+
+Bad example: `{@link BotBlockAPI}`  
+Good example: `{@link com.andre601.javabotblockapi.BotBlockAPI BotBlockAPI}`
+
+Note the alternative argument used in the good example.  
+A special case is used when linking to a method within the same class. In this case just link the method using #.  
+Example: `{@link #myMethod}`
+
+**Note**:  
+Use the `<a href="">` option to link external pages. When doing so also remember to include `target="_blank"`.  
+A link could look like this: `<a href="https://google.com" target="_blank">Google it!</a>` (You have to close it.)
+
+#### param styling
+When the method has parameters, you have to set a description with the `@param` option.  
+Note that the description has to be on a new line.
+
+**Example**:
+```java
+/**
+ * @param foo
+ *        The param description.
+ */
+```
+
+#### Since
+When adding new methods to the API, will you need to add a `@since` annotation at the end containing the new version.  
+Usually do only big, breaking changes increase the minor number (`v{major}.{minor}.{build}`) so usually you only increase the build.
+
+Please do NOT edit any already existing `@since` annotation.
+
+#### Other Styling
+Please make sure that all text is on the same vertical line (block).  
+This means that when f.e. a `@return` is used, that you have to use two spaces after `@param` instead of one.
+
+#### Example
+Here is an example of a method with all parts:  
+```java
+/**
+ * Adds "Bar" to the provided text.
+ * 
+ * @param  foo
+ *         The text that should get "Bar" added to it.
  *
- * @return What it returns. (Note to keep the param name, description and return value on same vertical line)
+ * @return The provided String with "Bar" added to it.
  *
- * @since vNew.version.here
+ * @since v1.0.0
  */
-public String myMethod(String bar){
-    return "foo" + bar;
+public String getFooBar(String foo){
+    return foo + "Bar";
 }
 ```