Contributing
Great to see you here. We appreciate your contribution and thank you for any kind of feedback or help. However, please read the following guidelines to avoid that your work gets rejected or you waste time. First of all this project is available under an open-source license and you have to agree that your contribution will also be subject to that license.
We are happy to receive your feedback, bug reports, and ideas for improvement. Please consider:
-
Do not misuse issues for asking questions. Questions should be asked via forum, stackoverflow, etc.
-
File the issue in the according repository (util, l10n, jpa, orient, etc.)
-
search if the same issue may already exist and comment on that instead of creating a duplicate
-
Include details to understand the issue (affected version, stacktrace, screenshot, etc.)
-
Describe the expected behaviour
-
Use proper syntax to mark code snipplets, bullet lists, stacktraces, etc.
We are looking forward to your code contribution. Please consider:
-
Please follow the github pull-request workflow and provide your change as pull-request (PR)
-
Before you get started read the DeveloperGuide
-
When you plan a bigger change ensure you get in touch via an issue first
-
When working on issues link your commit to the issue via the following syntax:
#<issueId>: <describe your change>In case you worked on an issue from a different repository use this commit message format:
m-m-m/<repository>#<issueId>: <describe your change>So as an example:
m-m-m/util#2: added support for named parameters in NLS message text
You found a typo in the documentation or you know a magic hint that is not yet documented? Great. You can just edit our wikis but please consider:
-
Technical usage documentation belongs to the JavaDoc and shall be contributed as code (see above)
-
Please follow these wiki syntax guidelines when editing or creating wiki pages
This documentation is licensed under the Creative Commons License (Attribution 4.0 International).
