Documentation
This directory centralizes documentation about how this repository works — its
structure, its build, and its conventions. User documentation for Drools, OptaPlanner, jBPM, and Kogito lives on
Apache KIE :: Documentation.
In this directory
| Document | What it covers |
|---|---|
| STRUCTURE.md | The module prefix structure, the BOM/parent-pom hierarchies, and architectural notes |
| BUILDING.md | How to build the repo, useful Maven flags and profiles, and troubleshooting |
| DEV.md | Building only the modules your changes affect, with make dev |
| CONVENTIONS.md | Code style, licensing, dependency rules, testing and codegen conventions |
| PR_CHECKS_AND_CI.md | The checks that run on pull requests, and how CI builds the repo |
| DEVELOP_ON_MACOS.md | Setting up macOS for GraalVM native image builds |
| OTHER_COMPONENTS.md | Apache KIE components beyond the four main projects: the PMML engine and KIE Tools |
| HISTORY.md | How KIE started, its initiatives over the years, and the move to Apache |
At the repository root
- README.md — project introduction
- CONTRIBUTING.md — contribution guide (issues, PRs, dependency requirements)