Updated readme.

This commit is contained in:
Aust1n46 2020-09-21 22:46:32 -05:00
parent 1e29fe0300
commit 69eb652a6f

View File

@ -10,17 +10,35 @@ VentureChat Spigot plugin Repo
Full setup and dependency guide is available here on SpigotMC: https://www.spigotmc.org/resources/venturechat.771/
##### Mavenified dependencies coming soon (TM) #####
Dependency List (for development):
* PlaceholderAPI
* Vault
* ProtocolLib
* Factions
* MassiveCore
* Towny
* Spigot versions 1.7 -> 1.16 (latest stable builds) (might not need every single version to compile)
* BungeeCord
* JUnit 4
* Mockito
* PowerMock
### Contribution guidelines ###
Keep changes simple and clear for me to understand
* Follow the existing style conventions. I used the default Eclipse formatting styleset for the majority of the project.
* Follow general Java best practices and object oriented principles. There are examples of poor practices in this existing legacy codebase, but that doesn't mean new contributions should stoop to that level.
* Include JavaDoc for your contribution. Same as stated above, most of this legacy codebase isn't documented, but that doesn't mean new contributions should also be undocumented. Especially important when multiple people are working on a project.
* Include unit tests for stand alone methods. I'm not expecting full coverage for complex Spigot events, etc, but for formatting or other non Spigot related code, tests would be much appreciated.
### Who do I talk to? ###
* If you are going to try and make all these changes, you should be talking to me directly otherwise I will more than likely just decline them.
* I'd recommend discussing any change before making it to avoid wasting your time and my time. Especially for a major change or if it's your first time contributing. I am extremely responsive on my Spigot discussion board (above link).
License:
Copyright (C) {2014} {Austin Brolly}
Copyright (C) {2020} {Austin Brolly}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by