Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

27 lines (15 loc) · 2.04 KB

Contributing to PotterPlus

Contributor Covenant Code of Conduct

I recommend reading this guide in its entirety before submitting a pull request or contributing to PotterPlus.

Q&A

What is the exact goal of this project?

The goal of PotterPlus is to create a configuration for NathanWolf's Magic plugin which faithfully recreate the world of Harry Potter in Minecraft.

What sort of pull requests are you looking for?

Anything! If you can make even the slightest contribution to PotterPlus it's pretty awesome on you. That said, I especially like marking off some of the items on the roadmap or resolving issues from the issue tracker as soon as possible.

I don't know how to configure the Magic plugin. How can I still help?

Magic is a fun plugin to work with! I'd be glad to give you some pointers on learning, though I understand if you are unwilling to commit the time. Besides written contributions, I appreciate reviewing the configuration for balance issues or bugs which can be added to the issue tracker. Another huge way that you can contribute to PotterPlus is through art assets. This can be icons, models, sound effects, etc.

Pull Requests

Before submitting a pull request to PotterPlus, please check the following:

  1. The directories are correct. PotterPlus has a specific organization which evolves over time as new features of Magic are utilized. As a general rule, I utilize the recursive loading feature of Magic wherein configuration is split up into separate, categorized files under each respective directory. To understand this, check out the /spells/ or /wands/ and observe the file structure.
  2. The file formatting is correct. All files are named in all snake case and end in .yml.
  3. All top-level nodes of configuration are formatted in all lowercase with no spacing between words.