|
| 1 | +[issues]: https://github.com/botblock/JavaBotBlockAPI/issues |
| 2 | +[Code of Conduct]: ./CODE_OF_CONDUCT.md |
| 3 | + |
| 4 | +## Contributing Guidelines |
| 5 | +We welcome everyone to contribute to the JavaBotBlockAPI project. |
| 6 | +But to keep a certain order and style over the project do you have to follow those guidelines here. But don't worry! They're fairly simple. |
| 7 | + |
| 8 | +## Issues |
| 9 | +If you encounter problems with the API feel free to open an issue on the [issues] tab. |
| 10 | +But before doing so make sure to check for the following things. |
| 11 | + |
| 12 | +### Using latest version |
| 13 | +We do not support old versions of this API. We release new versions to fix issues, update dependencies or add new methods. |
| 14 | +So if you encounter an issue or want a feature to be added, make sure to use the latest version as it might contain new functions and/or bugfixes. |
| 15 | + |
| 16 | +### Make sure it is not an issue of external (3rd party) libraries |
| 17 | +JavaBotBlockAPI uses different 3rd party libraries such as JDA and also depends on the [BotBlock API]. |
| 18 | +This means that some errors you encounter could be the cause of said 3rd party libraries or sites not working as intended. |
| 19 | +We can't fix issues related to those. If you encounter errors with those, go to the respective repository/site and report the issue. |
| 20 | + |
| 21 | +### Issue doesn't already exist |
| 22 | +Instead of creating a new issue explaining the same thing as the other one does, better go to the issue and comment on it to proof that it happens on multiple platforms. |
| 23 | +The best way for us to fix errors and issues is by gathering informations to find out why those issues happen. And having multiple issues complaining about the same issue won't help anyone here and only slows the process of fixing it down. |
| 24 | + |
| 25 | +### Follow the templates |
| 26 | +We have templates in place to make sure we receive the required informations. |
| 27 | +Please follow those templates or else your issue might get ignored and closed. |
| 28 | + |
| 29 | +---- |
| 30 | +## Pull Requests |
| 31 | +We accept pull requests for fixing issues or adding new features, but you have to follow those rules. |
| 32 | + |
| 33 | +### Javadocs |
| 34 | +Please add javadocs comments to **all public methods the developer has access to.** |
| 35 | +Javadocs help developers to see what methods they can/should use and what those do. |
| 36 | + |
| 37 | +When adding Javadoc comments, follow this template: |
| 38 | +```java |
| 39 | +/** |
| 40 | + * Short summary of what the method does. |
| 41 | + * <br>Start new lines with a {@code <br>} |
| 42 | + * |
| 43 | + * @param bar |
| 44 | + * Set the description in the new line. |
| 45 | + * |
| 46 | + * @return What it returns. (Note to keep the param name, description and return value on same vertical line) |
| 47 | + * |
| 48 | + * @since vNew.version.here |
| 49 | + */ |
| 50 | +public String myMethod(String bar){ |
| 51 | + return "foo" + bar; |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +## [Code of Conduct] |
| 56 | +We want to give everyone a chance to contribute to the project. |
| 57 | +So please keep your comments and messages nice. Every message that is considered rasist, insulting or similar will be removed. |
| 58 | +If you continue to send those messages you'll be permanently removed from this repository. |
0 commit comments