Blue-Falcon

Kotlin Multiplatform BLE library for iOS, Android, macos, windows and javascript

View the Project on GitHub Reedyuk/blue-falcon

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records (ADRs) for the Blue Falcon project.

What is an ADR?

An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences. ADRs help:

ADR Naming Convention

ADRs follow this naming pattern:

NNNN-title-with-dashes.md

Where:

Examples:

Creating a New ADR

To create a new ADR, use AI assistance by asking:

“Create a new ADR for [decision topic]”

Or manually:

  1. Find the highest numbered ADR in this directory
  2. Create a new file with the next number
  3. Copy the template from ADR-TEMPLATE.md
  4. Fill in the sections
  5. Commit with a descriptive message

ADR Status

ADRs can have the following statuses:

Index