Move docs from root to docs/ directory, create CHANGELOG.md and TODO.md

Agent-Logs-Url: https://github.com/christianlouis/dmarq/sessions/00a0c62f-f046-4f73-9c6a-79073906264c Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
2026-03-29 10:22:06 +00:00
parent 3f7a128c32
commit f686e854cb
10 changed files with 583 additions and 569 deletions
@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to DMARQ will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+- Reorganized repository: moved development docs (`AGENTS.md`, `ROADMAP.md`, `ISSUE_GENERATION_SUMMARY.md`, `generated_issues/`) into `docs/`
+- Added root-level `CHANGELOG.md` and `TODO.md`
+- Cleaned up root directory for clarity
+
+## [0.3.0] - 2026-02-09
+
+### Added
+- Database persistence with SQLAlchemy ORM (SQLite and PostgreSQL support)
+- Database migrations with Alembic
+- Persistent storage replacing in-memory data store
+
+### Security
+- Fixed missing authentication on admin endpoints (CRITICAL)
+- Replaced default SECRET_KEY with secure auto-generation (CRITICAL)
+- Replaced ElementTree with defusedxml to prevent XXE attacks (HIGH)
+- Fixed IMAP credentials exposure in URL query parameters (HIGH)
+- Added multi-layer file upload validation (HIGH)
+- Added security headers middleware (CSP, X-Frame-Options, HSTS, etc.) (MEDIUM)
+- Restricted CORS configuration (MEDIUM)
+- Sanitized error responses to prevent information disclosure (MEDIUM)
+- Added comprehensive security test suite
+
+## [0.2.0] - 2026-01-15
+
+### Added
+- IMAP integration for automatic DMARC report fetching
+- Background task scheduler for periodic mailbox polling
+- IMAP configuration UI with connection testing
+- Manual sync trigger and status indicators
+
+## [0.1.0] - 2025-12-01
+
+### Added
+- Initial release of DMARQ
+- DMARC XML report parsing (supports XML, ZIP, and GZIP formats)
+- In-memory storage of report data for up to 5 domains
+- Simple dashboard UI showing DMARC compliance statistics
+- Report upload via web interface
+- Domain overview with compliance rates and email statistics
+- Docker Compose deployment support
+- FastAPI backend with Jinja2 templates and Tailwind CSS