Contributing

Contributions are welcome. Follow these rules when you contribute.

Steps

Open an issue and wait for feedback. This tells you if the change will be accepted before you write any code.
- For a feature request, describe the feature in detail.
- For a bug report, give the steps to reproduce the bug and the result that you expected.
- For an enhancement, describe the change that you propose in detail.
Fork this repository.
Create a branch with a name that describes the change. For example, feature/add-xyz is good. fix-this-lol is bad.
Write the code for your change.
- In IntelliJ IDEA, the project includes the Plexus Code Style in .idea/codeStyles. IntelliJ uses it automatically.
- In other editors, follow the Plexus Code Style. It is close to the Allman style: put each opening brace on its own line.
Run ./gradlew build (on Windows, gradlew.bat build). The build must pass, including Checkstyle.
Push your branch and open a pull request from it.

The issue must be approved.
Each pull request addresses one issue only.
Your code must compile and work. If it does not, we will most likely reject the pull request.

Your code must be efficient. We can reject a pull request if the code is inefficient or sloppy.
Do not repeat code. If you use a large block of code more than once, move it into a method.
Do not add many small commits to your pull request. They make the project history hard to read.
Follow the existing code. If a method already does what you need, use it.

Read the documentation at plex.us.org for setup, configuration, and module development.