mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-28 19:06:12 +01:00
47 lines
2.4 KiB
Markdown
47 lines
2.4 KiB
Markdown
---
|
|
title: ADR Overview
|
|
---
|
|
|
|
## Introduction {#introduction}
|
|
|
|
Architectural decision records are a record of design decisions we have made in the past because we belived they would help our code quality over time. Any ADR can be challenged, but two conditions must be met to change an ADR:
|
|
1. The proposed solution must provide a tangible benefit in terms of code quality.
|
|
2. The benefits of the proposed solution must outweigh the effort of retroactively changing the entire codebase.
|
|
One such example is the decision to re-write Unleash to TypeScript.
|
|
|
|
## Overarching ADRs
|
|
|
|
These ADRs describe decisions that concern the entire codebase. They apply to back-end code, front-end code, and code that doesn't neatly fit into either of those categories.
|
|
|
|
* [Domain language](./overarching/domain-language.md)
|
|
* [Separation of request and response schemas](./overarching/separation-request-response-schemas.md)
|
|
|
|
## Back-end ADRs
|
|
|
|
We are in the process of defining ADRs for the back end. At the time of writing we have created the following ADRS:
|
|
|
|
* [Naming](./back-end/naming.md)
|
|
* [Preferred export](./back-end/preferred-export.md)
|
|
* [Breaking DB changes](./back-end/breaking-db-changes.md)
|
|
* [POST/PUT API payload](./back-end/POST-PUT-api-payload.md)
|
|
* [Specificity in database column references](./back-end/specificity-db-columns.md)
|
|
* [Write model vs Read models](./back-end/write-model-vs-read-models.md)
|
|
* [Frontend API Design](./back-end/frontend-api-design.md)
|
|
|
|
## Front-end ADRs
|
|
|
|
We have created a set of ADRs to help guide the development of the front end:
|
|
|
|
* [Component naming](./front-end/component-naming.md)
|
|
* [Interface naming](./front-end/interface-naming.md)
|
|
* [Preferred component props usage](./front-end/preferred-component-props-usage.md)
|
|
* [Preferred export](./front-end/preferred-export.md)
|
|
* [Preferred function type](./front-end/preferred-function-type.md)
|
|
* [Preferred styling method](./front-end/preferred-styling-method.md)
|
|
* [Preferred data mutation method](./front-end/preferred-data-mutation-method.md)
|
|
* [Preferred data fetching method](./front-end/preferred-data-fetching-method.md)
|
|
* [Preferred folder structure](./front-end/preferred-folder-structure.md)
|
|
* [Preferred form architecture](./front-end/preferred-form-architecture.md)
|
|
* [OpenAPI SDK generator](./front-end/sdk-generator.md)
|
|
* [Use of conditionals in JSX (refactor of <ConditionallyRender />)](./front-end/jsx-conditionals.md)
|