-
Notifications
You must be signed in to change notification settings - Fork 77
Pull Request Guidelines
When submitting a Pull Request, there are a few things that you should check to be ready for a review.
This might seem simple at first but there are some very important rules about what is allowed on some of our branches that have to be considered.
- 1: Never target the "stable" branch. If you think your changes should be targeting the "stable" branch, then they probably need to target "next-minor" instead. Any PR that targets the "stable" branch will be rejected.
- 2: "next-minor" should be targeted if your PR is only submitting small bug fixes or protocol updates for the "stable" branch. This means that your PR should not include behavior updates, AI tweaks, new mobs, or new features. If you have any of those things, you should be targeting the "master" branch.
- 3: "master" should be targeted anytime you are trying to introduce changes that add or modify behavior, movement AI, introduce new mobs, or implement new features.
NOTE: If you aren't sure which branch to target, then talk with us on Discord and we'll help you figure out which branch would be best.
Taking a few moments to check other Pull Requests to see if anyone else is already working on the changes you want to fix, may save you a lot of time. We will consider a PR in-active if the author has not made updates or communicated with us in 4 weeks or more.
Please make sure that your code formatting matches the rest of the code. This may seem like a silly thing, but it's important in the end to helping make the code stay uniform and clean. We provide a code formatting template for you to use with your IDE (Integrated Development Environment). You can find it here!