Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (63 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

99 lines (63 loc) · 2.78 KB

Contributing to Keycloak Push MFA Extension

Thanks for your interest in contributing! This document explains how to set up your environment, make changes, run tests, and submit a great pull request.

Code of Conduct

Be respectful and constructive. By participating, you agree to uphold a professional and inclusive environment.

Getting Started

  1. Fork the repository and create your feature branch:
    • git checkout -b feat/short-topic
  2. Make your changes (see Development below).
  3. Run formatting and tests locally (see Checks below).
  4. Commit using Conventional Commits (see below) and push your branch.
  5. Open a Pull Request against main.

JDK and Tooling

  • JDK: Use a modern LTS JDK.
  • Maven: Apache Maven 3.9+ recommended.

Project Layout

  • Source: src/main/java/...
  • Tests: src/test/java/...
  • Demo config: config/demo-realm.json
  • Scripts: scripts/*.sh

Checks (formatting, lint, tests)

Build and run tests locally:

  • mvn verify

If formatting fails locally, apply formatting fixes and re-run:

  • mvn spotless:apply

Please ensure all tests pass locally before opening a PR.

Commit Messages and Releases

This repository uses Conventional Commits (https://www.conventionalcommits.org/).

Please format your commit messages like:

<type>(optional scope): short description

[optional body]
[optional footer(s)]

Signed-off-by: Max Mustermann <max-mustermann@example.org>

Common types: feat, fix, docs, refactor, test, build, ci, chore.

Examples:

  • feat(auth): add DPoP validation to login challenge
  • fix(spi): prevent NPE when no push provider configured

Releases and changelogs are managed by release-please via GitHub Actions. Do not bump versions or edit CHANGELOG manually; use proper Conventional Commits and the bot will propose release PRs.

Developer Certificate of Origin

We have adopted a Developers Certificate of Origin (DCO). A DCO is a lightweight way for a developer to certify that they wrote or otherwise have the right to submit code or documentation to a project. To certify the code you submit to the repository, you'll need to add a Signed-off-by line to your commits.

$ git commit -s -m 'Awesome commit message'

Which will look something like the following in the repo:

Awesome commit message

Signed-off-by: Jane Smith <jane.smith@example.com>

Pull Request Guidelines

Before you submit:

  • Ensure the change is focused; split into multiple PRs if it spans unrelated concerns.
  • Add/adjust unit tests and integration tests when applicable.
  • Run mvn verify locally and ensure it passes.
  • Update documentation when user-facing behavior or setup changes.

License

By contributing, you agree that your contributions will be licensed under the Apache License, Version 2.0. See LICENSE for details.