Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2025-02-27 09:42:41 +01:00
Code Issues Projects Releases Wiki Activity
01bf7d1389
Essentials/README.markdown
drtshock 01bf7d1389 Update readme
2015-04-20 14:51:56 -05:00

1.7 KiB
Raw Blame History

EssentialsX Development Readme

This is a fork of Essentials called EssentialsX.

If you are using this, do NOT ask Essentials for support.

The official upstream repository is at https://github.com/Essentials/Essentials

Building

To build with Maven, use the command

mvn package dependency:copy

Jar files can then be found in the /jars folder

Commit Guidelines

Commits should fall into one of 3 areas:

  • [Feature]: Commits which are features should start with [Feature] and followed by a quick summary on the top line, followed by some extra details in the commit body.

  • [Fix]: Commits which fix bugs, or minor improvements to existing features should start with [Fix] and followed by a quick summary on the top line, followed by some extra details in the commit body.

  • Commits which fix bugs caused by previous commits (since last release), or otherwise make no functionality changes, should have no prefix. These will not be added to the project change log.

Other advice

Not all features are 'EssentialsX Ready'. EssentialsX is designed to cover the basic needs of Minecraft server administration, thus, we reject over 80% of feature requests that we deem are unsuitable.

Before developing an EssentialsX feature, we would recommend speaking to a developer in the EssentialsX IRC channel (#drtshock on irc.esper.net). Click here if you have a IRC client.

Support

Issue Tracker

Live Support available business hours (GMT -5)