CONTRIBUTING.md

How to contribute to Paradise Lost

If you found an issue:

• If the issue is a security vulnerability, DO NOT OPEN AN ISSUE ON GITHUB. Instead, to refer to our security policy.

• Check that the issue was not already reported by searching on GitHub under Issues. If an issue already exists, feel free to leave a comment on it with any important information.

• If you're unable to find an open issue addressing the problem, open a new one.

• Be sure to use the relevant bug report templates to create the issue:

  • Crash Report for issues involving a crash
  • Bug Report for other issues
  • Accessibility for accessibility requests
  • Feature Request for other suggestions

For code contributions:

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem (or a link to the relevant issue, if applicable) and solution. Use the PR template.

• Before submitting, please check that your code matches our code style. The repo contains a checkstyle, which you should try to follow.

Do you have write access to the repo and want to make a change?

• MAKE A PULL REQUEST FOR NEW FEATURES.
• Refer to these details on contribution and branch names:

**<VER>/<MCVER>/master**: Assume these are production/live branches unless otherwise written or stated.
  - Only push code here that is tested and expected to ship in the next applicable update
  
**<VER>/<MCVER>/<FEATURE_NAME>**: Feature branches designated for the specified upcoming release
  - These branches get merged into **<VER>/<MCVER>/master** when applicable, ready, and tested enough to be accepted.

Did you fix whitespace, format code, or make a purely cosmetic patch?

• Changes that are cosmetic in nature and do not add anything substantial to the project will likely not be accepted.
• Documentation changes may be accepted if the changes are not just grammar fixes.

Do you intend to add a new feature or change an existing one?

• Suggest your change as a feature request or to our discord first. If you don't, you might spend a bunch of time on something we end up rejecting.

Do you have questions about the source code?

• Ask any question about our code in our discord. You can also use the blank issue form, but it is not recommended.

Do you want to contribute to documentation?

• Please see this file and the following example about documentation:

    /**
     * Write reasonable documentation for non-obvious methods.
     * For public facing APIs, like {@link net.id.paradiselost.api.MoaAPI} or {@link net.id.paradiselost.api.FloatingBlockHelper}, 
     * fully document everything that is public. ^ (Also, use these @link tags when possible)
     * <br>Use @param and @return tags if non-obvious or if specific values may give strange results.
     * <br>If you didn't write the code and you're just adding docs, end your docs with a tilde and your
     * name/username. If you did write it, then just the @author tag is alright.
     * <br>~ Jack
     */

Paradise Lost is nothing without its community. We encourage you to pitch in and help out or join the team!

Thanks for reading! ❤️ ❤️ ❤️

-Immortal Devs