Merge pull request #2 from ppon1086/dev

Promote OSS cleanup, tests, CI, and docs from dev to main

Author: ppon1086

.github/workflows/ci.yaml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - chore/**
+      - feat/**
+      - fix/**
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip setuptools wheel
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install -e .
+          pip install pytest
+
+      - name: Run tests
+        run: pytest -q

.gitignore

@@ -0,0 +1,22 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+
+# Virtual environments
+.venv/
+.venv313/
+
+# Build / packaging
+ragcitecheck.egg-info/
+dist/
+build/
+
+# Outputs
+out_check/
+out_report/
+out_validate/
+
+# OS
+.DS_Store
+Thumbs.db

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+### Added
+- adapter and harness utilities for evidence logging
+- minimal CLI smoke tests for validate and report
+- GitHub Actions CI for push and pull requests
+
+### Changed
+- improved core validation and reporting flow
+- rewrote README for adoption, integration, and quickstart
+- updated minimal fixture logs for current CLI format
+- improved dependency setup for Python 3.13 development
+
+### Fixed
+- CLI report wiring for evidence-key and alias handling
+- duplicate report call block in CLI
+- default alias issues in CLI field handling
+
+## v0.1.0
+
+### Added
+- initial validation and stability reporting pipeline
+- example logs and basic package skeleton

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing
+
+Thanks for your interest in contributing to `ragcitecheck`.
+
+## Development setup
+
+Clone the repo and create a virtual environment.
+
+### Windows
+
+```bash
+py -3.13 -m venv .venv313
+.venv313\Scripts\activate
+python -m pip install --upgrade pip setuptools wheel
+pip install -r requirements.txt
+pip install -e .
+pip install pytest
+```
+
+### macOS / Linux
+
+```bash
+python3.13 -m venv .venv313
+source .venv313/bin/activate
+python -m pip install --upgrade pip setuptools wheel
+pip install -r requirements.txt
+pip install -e .
+pip install pytest
+```
+
+## Running tests
+
+Run the smoke tests with:
+
+```bash
+pytest -q
+```
+
+## Project scope
+
+`ragcitecheck` focuses on evidence stability diagnostics for RAG pipelines, including:
+
+- document-level citation overlap
+- span-level evidence overlap
+- per-query instability summaries
+- lightweight validation and reporting workflows
+
+Please keep changes aligned with this scope.
+
+## Pull requests
+
+Please open pull requests against the `dev` branch.
+
+A good PR should:
+
+- keep changes focused and small
+- include tests when behavior changes
+- avoid committing generated outputs or large artifacts
+- update docs when CLI behavior or input format changes
+
+## Repo hygiene
+
+Please do not commit:
+
+- `__pycache__`
+- `.egg-info`
+- local virtual environments
+- generated reports
+- benchmark output folders
+- zip archives
+- large experiment artifacts
+
+## Reporting issues
+
+If you open an issue, it is helpful to include:
+
+- the command you ran
+- the input format used
+- the exact error message
+- Python version
+- operating system