# AGENTS.md

## Project overview
This software project aims to create a web application that allows users to enter technical details of a security incident or alert and obtain a draft incident report.

The app currently uses the Streamlit framework for the graphical interface and backend logic. No data is stored, so there is no data persistence layer.

Hosted on HuggingFace.

## Setup commands
- Install deps: `pipenv install`
- Start dev server: `pipenv run streamlit run .\src\app.py`
- Run tests: Tests doesn't exists yet

## Code style
- Python best practices: https://peps.python.org/pep-0008/
- Use double-quoted when possible.

## Contribution guidelines
- Follow the Conventional Commits guidelines when commit changes: https://www.conventionalcommits.org/