Answer logging addition

[ajs2583]

This pull request introduces a comprehensive set of improvements to the repository's automation and documentation. The most significant additions are the introduction of GitHub Actions workflows for CI, code quality, dependency review, PR labeling, stale issue management, and PR change logging. Additionally, the documentation is expanded to cover new qualitative answer logging features, including usage examples and data formats.

Automation and CI/CD enhancements:

• Added .github/workflows/ci.yml to run linting, formatting, type checks, and tests for both the main project and the DocGPT subproject across multiple Python versions.
• Introduced .github/workflows/codeql.yml for automated CodeQL security analysis on pushes, pull requests, and a weekly schedule.
• Added .github/workflows/dependency-review.yml to review dependencies on pull requests, fail for high-severity vulnerabilities, and comment summaries in PRs.
• Added .github/workflows/pr-changelog.yml to automatically generate and update a PR change log comment summarizing file changes, stats, dependency diffs, and warnings for large changes.
• Introduced .github/workflows/auto-label.yml and .github/labeler.yml for auto-labeling PRs based on changed files and PR size, improving triage and review efficiency. [1] [2]
• Added .github/workflows/stale.yml to automatically mark and close stale issues and PRs after configurable periods of inactivity.

Documentation and qualitative logging improvements:

• Expanded README.md to document qualitative answer logging features, including side-by-side comparison of RAG and direct LLM answers, structured output formats (CSV/JSON), CLI usage, and example data formats. [1] [2] [3] [4] [5] [6] [7]

New features and file additions:

• Added rag_evaluation/qualitative_logger.py module for qualitative logging of answers, referenced in the updated project structure in the documentation.

These changes collectively modernize the repository with robust automation, improve code quality and security, and provide clear guidance for qualitative evaluation workflows.

---

Automation & CI/CD:

• Added CI workflow for linting, formatting, type checking, and testing on multiple Python versions and subprojects (.github/workflows/ci.yml).
• Introduced security analysis with CodeQL, dependency review, stale issue management, and automated PR change logging workflows (.github/workflows/codeql.yml, .github/workflows/dependency-review.yml, .github/workflows/stale.yml, .github/workflows/pr-changelog.yml). [1] [2] [3] [4]
• Implemented auto-labeling for PRs based on changed files and PR size, including label configuration (.github/workflows/auto-label.yml, .github/labeler.yml). [1] [2]

Documentation:

• Expanded README.md with detailed qualitative answer logging instructions, CLI usage, new data formats, and updated example references. [1] [2] [3] [4] [5] [6] [7]

New Features:

• Added qualitative logging module (rag_evaluation/qualitative_logger.py) and documented its usage in the project structure.

[github-actions]

PR Change Log

Changed Files Summary

Overall: 7 files changed, 647 insertions(+), 11 deletions(-)

Files Changed

Status	File	Lines Added	Lines Removed
Modified	README.md	+175	-11
Added	examples/qualitative_eval.py	+226	-0
Added	examples/sample_qualitative_data.csv	+4	-0
Modified	pyproject.toml	+1	-0
Modified	rag_evaluation/__init__.py	+5	-0
Modified	rag_evaluation/data_ingestion/datatable_loader.py	+43	-0
Added	rag_evaluation/qualitative_logger.py	+193	-0

Changes by Directory

• ./: 3 file(s)
• rag_evaluation/: 2 file(s)
• examples/: 2 file(s)
• rag_evaluation/data_ingestion/: 1 file(s)

Dependency Changes

Warnings

No large file changes detected.

---

Updated: 2026-02-11T18:28:23.599Z