Skip to content

Commit 33b899d

Browse files
committed
docs: professional README and OSS layout for v0.2.0
1 parent 31c5211 commit 33b899d

32 files changed

Lines changed: 221 additions & 314 deletions

‎.current_session‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.gitignore‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
11
# Python-generated files
22
__pycache__/
33
*.py[oc]
4+
*.pyc
45
build/
56
dist/
67
wheels/
7-
*.egg-info
8+
*.egg-info/
89

910
# Virtual environments
10-
.venv
11-
.venv-ship
11+
.venv/
12+
.venv-ship/
1213
.env
1314

15+
# Secrets / sessions
16+
.current_session
17+
18+
# Local runtime data
1419
qdrant_data/
1520
repos/
1621
graphify-out/
17-
.env
18-
# Generated repository intelligence
19-
.codeturtle/
20-
21-
# Local DB
22+
tmp/
2223
data/
24+
outputs/
2325

24-
# Sessions
25-
.current_session
26+
# Snapshots / artifacts
27+
artifacts/last_review_snapshot.json
28+
29+
# Codeturtle generated intelligence
30+
.codeturtle/
2631

27-
# Debug
32+
# Debug text dumps
2833
debug_*.txt
2934

30-
# Eval snapshots from live reviews
31-
artifacts/
35+
# GitHub
36+
.github/copilot-instructions.md

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
## 0.2.0
4+
5+
- Installable `codeturtle` console script
6+
- Smoke: confident-ai/deepeval#3288 --dry-run → REQUEST_CHANGES
7+
- Offline goldens: qw-538, qw-571, deepeval-3288

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
Python 3.11+.
6+
7+
```bash
8+
uv sync
9+
pip install -e ".[ollama,graphify]"
10+
```
11+
12+
`codeturtle --help` must work.
13+
14+
## Checks before PR
15+
16+
```bash
17+
codeturtle --help
18+
uv run python -m tests.evaluation.run_eval --offline
19+
```
20+
21+
Both must pass. Do not commit `.env` or tokens.
22+
23+
## Reviews
24+
25+
Default is `--dry-run`. Do not `--comment` on repos you do not own.
26+
27+
## Issues
28+
29+
Paste `--dry-run -v` logs with tokens redacted.

0 commit comments

Comments
 (0)