Skip to content
This repository has been archived by the owner on Nov 2, 2021. It is now read-only.

Latest commit

 

History

History
20 lines (15 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 2.19 KB
Raw

Help and issues

Found a problem or need some help? The following steps may help:

  1. Make sure you have gone through the Wiki. A lot of questions have an answer in there!
  2. Upgrade to the latest version of the plugin (available here) and a recent Spigot/Bukkit build for your Minecraft version (see here).
  3. Check your server's logs (including when plugins are loaded!), there may be warnings/errors/stack straces to help you out with your issue.
  4. Do a quick search through the existing issues, you might get lucky!
  5. Simply open a new issue and carefully fill out one of the three forms available if none of the above help or if you want to suggest a new feature! Help is free, so be polite and friendly! ❤️

Pull requests

Want to make Advanced Achievements better, faster, stronger? Contributions are more than welcome, open a pull request and share your code! Here are a few pointers to help you out:

  1. Feel free to open an issue to get advice or discuss your change beforehand!
  2. Go through the Developers guide to get the project up and running and learn how to interact with the plugin.
  3. We use Dagger, a popular dependency injection tool which will hopefully make your life easier. Have a browse through the code or take a look at the docs, you should quickly get a hang of how it works!
  4. If you are unsure about how to do something, simply ask by tagging @PyvesB!
  5. Historically the plugin has had poor test coverage, so don't worry too much if you can't add any tests with your pull request. Nevertheless if you want improve maintainability and practice your unit testing skills, please do!
  6. Run mvn formatter:format to make sure that your code style is consistent with the rest of the project. Your pull request should be ready for submission! 👍