docs(): added linting and formatting docs

This commit is contained in:
ITQ
2026-02-23 16:54:48 +03:00
parent 15d80532e0
commit 85bed92364
2 changed files with 30 additions and 2 deletions
+4 -2
View File
@@ -1,7 +1,5 @@
# Lotty A/B Platform # Lotty A/B Platform
[![wakatime](https://wakatime.com/badge/user/cb406c1c-8eb4-4829-b9f9-816a0d284d7e/project/072eef64-ba2e-4a95-a5bb-62e22186eb22.svg)](https://wakatime.com/badge/user/cb406c1c-8eb4-4829-b9f9-816a0d284d7e/project/072eef64-ba2e-4a95-a5bb-62e22186eb22)
Service for managing A/B testing experiments. Drive your tests without breaking user experience!_) Service for managing A/B testing experiments. Drive your tests without breaking user experience!_)
## 📋 Instructions ## 📋 Instructions
@@ -53,3 +51,7 @@ docker compose -f compose.prod.yaml up
``` ```
Thats it, project is already preconfigured for running, so no changes before running this are required. Thats it, project is already preconfigured for running, so no changes before running this are required.
## Linting and formatting
Described [here](./src/backend/README.md#)
+26
View File
@@ -121,3 +121,29 @@ just test-coverage
```bash ```bash
just show-coverage just show-coverage
``` ```
## Linting && Formatting
### Clone the project
### Go to the project directory
### Install dependencies
```bash
uv sync --all-extras
```
### Run format
```bash
just format
```
### Run lint
```bash
just lint
# OR
just fix # applies suggested fixes
```