Tobias Pasquale commited on
Commit
7effb84
·
1 Parent(s): afecdc5

docs: Add CHANGELOG.md reference to README for better team collaboration

Browse files

- Add Development Progress section in README
- Reference CHANGELOG.md for detailed development tracking
- Improve team alignment on project progress and technical decisions

Files changed (1) hide show
  1. README.md +12 -0
README.md CHANGED
@@ -48,6 +48,18 @@ pytest
48
 
49
  Current tests cover the basic application endpoints (`/health` and `/`). As we implement more features (ingestion, embeddings, RAG, chat API), we will add tests for those components following TDD.
50
 
 
 
 
 
 
 
 
 
 
 
 
 
51
  ## CI/CD and Deployment
52
 
53
  This repository includes a GitHub Actions workflow that runs tests on push and pull requests. After merging to `main`, the workflow triggers a Render deploy and runs a post-deploy smoke test against `/health`.
 
48
 
49
  Current tests cover the basic application endpoints (`/health` and `/`). As we implement more features (ingestion, embeddings, RAG, chat API), we will add tests for those components following TDD.
50
 
51
+ ## Development Progress
52
+
53
+ For detailed development progress, implementation decisions, and technical changes, see [`CHANGELOG.md`](./CHANGELOG.md). The changelog provides:
54
+
55
+ - Chronological development history
56
+ - Technical implementation details
57
+ - Test results and coverage metrics
58
+ - Component integration status
59
+ - Performance benchmarks and optimization notes
60
+
61
+ This helps team members stay aligned on project progress and understand the evolution of the codebase.
62
+
63
  ## CI/CD and Deployment
64
 
65
  This repository includes a GitHub Actions workflow that runs tests on push and pull requests. After merging to `main`, the workflow triggers a Render deploy and runs a post-deploy smoke test against `/health`.