A Forge/Bukkit/Spigot Minecraft Server
We use Maven to handle our dependencies.
- Note: this is not needed as the repository we use has MCPC-API too, but you might have a newer one (with your own changes :D)
- Check out this repo and run:
mvn initialize -P -builtmvn clean package
If you get "Could not find artifact net.minecraftforge:minecraft-forge:jar", repeat step 3. To fix "out of heap space", run mvn with more memory: MAVEN_OPTS=-mx2G
We use YourKit as our Java Profiler.
YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products:
- We generally follow the Sun/Oracle coding standards.
- No tabs; use 4 spaces instead.
- No trailing whitespaces.
- No CRLF line endings, LF only; will be converted automatically by git
- No 80 column limit or 'weird' midstatement newlines.
- The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!).
- No merges should be included in pull requests unless the pull request's purpose is a merge.
- Pull requests should be tested (does it compile? AND does it work?) before submission.
- Any major additions should have documentation ready and provided if applicable (this is usually the case).
- Most pull requests should be accompanied by a corresponding GitHub ticket so we can associate commits with GitHub issues (this is primarily for changelog generation on ci.md-5.net).
- Try to follow test driven development where applicable.
If you make changes to or add upstream classes (net.minecraft, net.minecraftforge, cpw.mods.fml, org.bukkit, org.spigotmc) it is mandatory to:
- Make a separate commit adding the new net.minecraft classes (commit message: "Added x for diff visibility" or so).
- Then make further commits with your changes.
- Mark your changes with:
- 1 line; add a trailing:
// MCPC+ [- Optional reason] - 2+ lines; add
- Before:
// MCPC+ start [- Optional comment] - After:
// MCPC+ end
- Before:
- 1 line; add a trailing:
- Keep the diffs to a minimum (somewhat important)
Making sure you follow the above conventions is important, but just the beginning. Follow these tips to better the chances of your pull request being accepted and pulled.
- Make sure you follow all of our conventions to the letter.
- Make sure your code compiles under Java 6.
- Provide proper JavaDocs where appropriate.
- Provide proper accompanying documentation where appropriate.
- Test your code.
- Make sure to follow coding best practices.
- Provide a test plugin/mod binary and source for us to test your code with.
- Your pull request should link to accompanying pull requests.
- The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable.