Keycloak Operator is an Open Source solution to easily deploy and manage Keycloak server instances.
Details for building from source and working with the codebase are provided in the building and working with the code base guide.
The Keycloak Operator is an Open Source community-driven project and we welcome contributions as well as feedback from the community.
We do have a few guidelines in place to help you be successful with your contribution.
Here's a quick checklist for a good PR, more details below:
- Keycloak Dev Mailing List
- A GitHub Issue with a good description associated with the PR
- One feature/change per PR
- One commit per PR
- PR rebased on main (
git rebase, notgit pull) - Commit message is prefixed by the issue number (for example
#58 Message) - No changes to code not directly related to your PR
- Includes test
- Includes documentation
Once you have submitted your PR please monitor it for comments/feedback. We reserve the right to close inactive PRs if you do not respond within 2 weeks (bear in mind you can always open a new PR if it is closed due to inactivity).
Also, please remember that we do receive a fairly large amount of PRs and also have code to write ourselves, so we may not be able to respond to your PR immediately. The best place to ping us is on the thread you started on the dev mailing list.
If you would like to contribute to Keycloak, but are not sure exactly what to work on, you can find a number of open issues that are awaiting contributions in the GitHub Issues.
As Keycloak is a community-driven project we require contributors to send a description of what they are planning to work on to the Keycloak Dev Mailing List.
We recommend starting the discussion prior to submitting your PR. Through the mailing list you can get valuable feedback both from the core Keycloak team as well as the wider community.
Take your time to write a proper issue including a good summary and description.
Remember this may be the first thing a reviewer of your PR will look at to get an idea of what you are proposing and it will also be used by the community in the future to find about what new features and enhancements are included in new releases.
Details for building from source and working with the codebase are provided in the building and working with the code base guide.
Do not format or refactor code that is not directly related to your contribution. If you do this it will significantly increase our effort in reviewing your PR. If you have a strong need to refactor code then submit a separate PR for the refactoring.
We require contributions to include relevant documentation. Alongside your PR for code changes, prepare a PR to the Keycloak Documentation.
In the description of your PR include a link to the PR to Keycloak Documentation.
When preparing your PR make sure you have a single commit and your branch is rebased on the main branch from the project repository.
This means use the git rebase command and not git pull when integrating changes from main to your branch. See
Git Documentation for more details.
We require that you squash to a single commit. You can do this with the git rebase -i HEAD~X command where X
is the number of commits you want to squash. See the Git Documentation
for more details.
The above helps us review your PR and also makes it easier for us to maintain the repository. It is also required by our automatic merging process.
We also require that the commit message is prefixed with the issue number (example commit message
#12 My super cool new feature).