Skip to content

Latest commit

 

History

History
27 lines (12 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

27 lines (12 loc) · 2.14 KB

Help us to make a better tool

By creating issue-tickets

When you think you found a bug, please check the issue-tracker at github first, if it isn't already reported. If you are unsure about having the same bug, don't hesitate to create a new issue-ticket, you will be informed about via comment or closing.

By creating patches, features or pull-requests

When you managed to find some time in creating a patch or implemented a new feature, please create small pull-requests. Having to merge a pull-request with different fixes or several new features is no easy task and won't be accepted (exceptions of this may occur when having similar small fixes). If new features are added, please create a sample-project inside src/it/-folder, this will be called by maven-invoker-plugin to ensure all other existing features aren't broken and working as expected. This is also a good documentation to others by showing them how to set their configuration.

Some words about code-formatters and comments

I love code-formatters, but until I have strict requirements for this project (I don't have them currently), please do not apply your formatter over the whole code, just on your changes should be enough. It shortens the time to check pull-requests for the change you really made (and not making the code look worse than it is).

If there are some comments you find irritating or confusing (or even being wrong), just create a pull-request to adjust these parts.

Inform others about this project

This project lives from the usage by others, show it to some collegues, use it in your spare-time-projects and feel free to spread this project all over the world. Every move to keep this project alive and kicking is very welcome.

Note about creator/maintainer-feedback

It may happen, that some comments are getting more rude than expected, this just means that there is a lot of personal commitment is involved. My comments are never for personal insults, just my personal way of pushing my own project. If this hurts your feelings I can assure you that I'm getting hurt feelings myself, but I never see them as a personal attack, so you shouldn't too.