Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

86 lines (57 loc) · 2.36 KB
Raw

Contributing

Contributions are very welcome. The following will provide some helpful guidelines.

Initial setup

Please consider installing pre-commit and registering it for this repo by runnning

pre-commit install

This will ensure correct file formatting by registering a pre-commit hook. If committing fails, check the unstaged changes and add them to the staging area, then commit.

How to build the project

KeycloakMock requires JDK 8. To build the entire project run

./gradlew build

Core functionality

The main logic of the KeycloakMock is located in the mock module. It contains a lightweight mock implementation of the most commonly used REST APIs. In addition, it offers the functionality to generate user-defined access tokens which can be validated with the provided the public signature key endpoint. To build, run

./gradlew mock:build

JUnit integration

JUnit integration is provided in mock-junit (for JUnit 4) and mock-junit5.

Standalone Mock

standalone bundles the functionality of the mock module in a single JAR with no external dependencies.

How to contribute

If you want to submit a contribution, please follow the following workflow:

  • Fork the project
  • Create a feature branch
  • Add your contribution
  • Add sufficient tests along with new features
  • When you're completely done, build the project and run all tests via ./gradlew clean build
  • Create a Pull Request

Commits

Commit messages should be clear and fully elaborate the context and the reason of a change. If your commit refers to an issue, please post-fix it with the issue number, e.g.

Issue: #123

Furthermore, commits should be signed off according to the DCO.

Pull Requests

If your Pull Request resolves an issue, please add a respective line to the end, like

Resolves #123

Formatting

This project uses google code style. Running pre-commit run --all-files will automatically format java code correctly. See here for IDE integration.

Updating the baseline

This repository uses a rebase-only strategy. When you need to update your branch to include the latest changes from the main repository, please do not merge them but rebase your changes.