docs: introduce ADRs

.github/workflows/e2e-test.yml

@@ -5,10 +5,12 @@ on:
   pull_request:
     paths-ignore:
       - 'docs/**'
+      - 'adr/**'
     branches: [ main, next ]
   push:
     paths-ignore:
       - 'docs/**'
+      - 'adr/**'
     branches:
       - main
       - next

.github/workflows/pr.yml

@@ -10,6 +10,7 @@ on:
   pull_request:
     paths-ignore:
       - 'docs/**'
+      - 'adr/**'
     branches: [ main, v1, v2, v3, next ]
   workflow_dispatch:
 jobs:

.github/workflows/sonar.yml

@@ -10,10 +10,12 @@ on:
   push:
     paths-ignore:
       - 'docs/**'
+      - 'adr/**'
     branches: [ main ]
   pull_request:
     paths-ignore:
       - 'docs/**'
+      - 'adr/**'
     types: [ opened, synchronize, reopened ]
 
 jobs:

adr/001-Introducing-ADRs.md

@@ -0,0 +1,29 @@
+# Using Architectural Decision Records
+
+In order to into to document and facilitate discussion over architecture and other design question of the project
+we introduce usage of [ADR](https://adr.github.io/).
+
+In each ADR file, write these sections:
+
+# Title
+
+## Status
+
+What is the status, such as 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 proposing and/or doing?
+
+## Consequences
+
+What becomes easier or more difficult to do because of this change?
+
+## Notes
+
+Other notes optionally added to the ADR.
+Soo other good materials for the ADRs: