Files
AuxProtect-Folia/README.md
ks-hl 43bfa48bfe Update README.md
Added contributor guidelines
2024-08-04 10:32:27 -04:00

35 lines
1.1 KiB
Markdown

# AuxProtect
Wiki: https://github.com/Heliosares/AuxProtect/wiki
## API
[![](https://jitpack.io/v/Heliosares/AuxProtect.svg)](https://jitpack.io/#Heliosares/AuxProtect)
### Maven
```
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
<dependency>
<groupId>com.github.Heliosares</groupId>
<artifactId>AuxProtect</artifactId>
<version>1.3.1</version>
<scope>provided</scope>
</dependency>
```
### Gradle
```
maven { url 'https://jitpack.io' }
implementation 'com.github.Heliosares:AuxProtect:1.3.1'
```
## Contributors
Thank you for considering helping out. :)
Please base any PRs off of the `refactor-modules` branch, that is my working branch and has pretty significant structure changes.
### Formatting
- Ask, before you work on a PR, if the change is something I would implement. I don't want you to waste time if it's not something I want added.
- Please only change code that is necessary to your PR.
- Do not use wildcard imports. (e.g. `java.util.*`)
- Try to match the formatting of the rest of the code. (IntelliJ default autoformat with the exception of wildcard imports)