mirror of https://github.com/actions/setup-java.git synced 2024-12-27 01:12:12 -05:00

Josh Soref 72c7c408b4 link: more information about ADRs

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

2024-12-19 10:57:27 -05:00

ADRs

ADR, short for "Architecture Decision Record" is a way of capturing important architectural decisions, along with their context and consequences.

This folder includes ADRs for the setup-java action. ADRs are proposed in the form of a pull request, and they commonly follow this format:

Title: short present tense imperative phrase, less than 50 characters, like a git commit message.
Status: proposed, accepted, rejected, deprecated, superseded, etc.
Context: what is the issue that we're seeing that is motivating this decision or change.
Decision: what is the change that we're actually proposing or doing.
Consequences: what becomes easier or more difficult to do because of this change.