Firstly, anyone is more than welcome to contribute to WildFly Operator, so big thanks for considering it. You can contribute by reporting and fixing bugs, improving the documentation or requesting and implementing new features.
You only must follow the guidelines described on this document.
We are serious about making this a welcoming, happy project. We will not tolerate discrimination, aggressive or insulting behaviour.
To this end, the project and everyone participating in it is bound by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to any of the project admins.
If you find a bug, please open an issue! Do try to include all the details needed to recreate your problem. This is likely to include:
- The version of the WildFly Operator
- The exact platform and version of the platform that you're running on
- The steps taken to cause the bug
If you're looking for something to work on, take look at the issue tracker, in particular any items labelled good first issue. Please leave a comment on the issue to mention that you have started work, in order to avoid multiple people working on the same issue.
If you have an idea for a feature - whether you have time to work on it - please also open an issue describing your feature and label it "enhancement". We can then discuss it as a community and see what can be done. Please be aware that some features may not align with the project goals and might therefore be closed. In particular, please don't start work on a new feature without discussing it first to avoid wasting effort. We do commit to listening to all proposals and will do our best to work something out!
On opening a PR, a GitHub action will execute the test suite against the new code. All code is required to pass the tests, and new code must be accompanied by new tests.
All PRs have to be reviewed and signed off by another developer before being merged to the main branch. This review will likely ask for some changes to the code - please don't be alarmed or upset at this; it is expected that all PRs will need tweaks and a normal part of the process.
Be aware that all WildFly Operator code is released under the Apache 2.0 licence.
The WildFly Operator README contains a section that describes how you can work with the WildFly Operator from the developer point of view. Take a look at the Developer Instructions section to learn how you can use the WildFly Operator on your local environment for development purposes.
This guideline has been elaborated following these resources: Java Operator SDK