vinez/headroom
1
0
Fork 0
mirror of https://github.com/headroomlabs-ai/headroom.git synced 2026-08-10 14:27:00 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
headroom/.gitignore
Tejas Chopra a639540959
chore: remove committed node_modules + stray/internal markdown (repo hygiene) (#1528) 
## Description

Repo hygiene for a public OSS project: removes committed `node_modules`,
stray/internal/draft markdown, and commercial-surface references —
keeping every real doc (the published docs site, the wiki guides, and
all component READMEs) intact. Every file was content-audited before
removal, and load-bearing files were verified against the code/CI and
kept.

Net: **1,695 files changed, +23 / −266,409** (the deletions are
dominated by a committed `node_modules` tree).

Closes # (no tracking issue)

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [x] Code refactoring (no functional changes)

## Changes Made

**Removed (verified to have no code/CI dependencies):**
- `examples/vercel-ai-sdk-pr/` — 1,649 committed `node_modules` files
(zero example source); `node_modules/` added to `.gitignore`.
- `docs/spec/` (23 draft "Living Specification" files — orphaned,
`1.0.0-draft`, drifted from the code), `docs/superpowers/` (2 agent
plans), `docs/proposals/` (2 internal/commercial memos).
- 6 orphan `docs/*.md` (auth-modes, bedrock,
claude-code-vertex-headroom, cortex-code, output-token-reduction-guide,
rtk-loop-weighting).
- `PR.md` (committed PR draft), `ENTERPRISE.md`, `.github/FUNDING.yml`.

**Content scrubs:**
- Removed unreleased "Headroom Cloud" / `api.headroom.ai` / `hr_`
references from `configuration.mdx`, `wiki/configuration.md`,
`wiki/typescript-sdk.md`, `sdk/typescript/README.md` (reworded to
neutral, accurate phrasing).
- Dropped a stale "awaiting maintainer before merge" line from
`plugins/headroom-oauth2/SPEC.md`; tidied `.gitignore` comments (kept
the protective `headroom-managed/` ignore rule).
- Fixed the now-dangling links into removed files (README
nav/`output-token-reduction` link, `scripts/README`, `wiki/vertex`).

**Explicitly KEPT (load-bearing — would orphan in-code citations if
removed):**
- `.changelog.md` — consumed by `.github/workflows/release.yml` (read as
the release-notes file).
- `REALIGNMENT/`, `docs/observability.md`, `docs/rtk-architecture.md`,
`wiki/plans/`, `TESTING-copilot-subscription.md` — referenced by the
Rust core / Python / tests as design docs.

## Testing

- [ ] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check`)
- [ ] Type checking passes (`mypy`)
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
# Docs/markdown + .gitignore only — no Python/Rust source changed, so the
# behavioral test suite is unaffected. Verified the cleanup did not orphan
# references or break the published docs site:

$ git ls-files 'docs/content/docs/*.mdx' | wc -l      # published site intact
42
$ # meta.json nav unchanged; no published page removed.

$ grep -rnI "Headroom Cloud|api.headroom.ai|'hr_" $(git ls-files '*.md' '*.mdx')
>>> none

$ # dangling refs to removed files (excl pre-existing P0/P2 spec stubs that
$ # never existed in git): none remaining.
```

## Real Behavior Proof

- Environment: macOS, local git clone of the repo (markdown/.gitignore
changes only — no runtime).
- Exact command / steps: 4 read-only content-audit agents classified
every `.md`/`.mdx` file; each removal candidate was cross-checked
against the codebase (`grep` for citations in `.rs`/`.py`/tests,
workflows, and configs); only files with no dependents were removed; the
tree was re-grepped after removal to confirm no new dangling references;
verified the published docs site page count (`git ls-files
'docs/content/docs/*.mdx' | wc -l` = 42, unchanged).
- Observed result: the 42-page published docs site and all wiki guides
are untouched; no source or workflow references a removed file;
`.changelog.md` (consumed by release.yml) and the code-cited design docs
were detected as dependencies and kept; the committed `node_modules`
tree is removed and `node_modules/` is gitignored so it can't be
re-committed; zero "Headroom Cloud"/`headroom.dev` references remain.
- Not tested: N/A — no executable code changed (only markdown, `.mdx`,
and `.gitignore`), so the behavioral test suite is unaffected.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] I have updated the CHANGELOG.md if applicable

## Additional Notes

- This branch deletes `.github/FUNDING.yml` while PR #1526 edits it —
the two will be sequenced at merge (delete wins).
- A follow-up option (not in this PR): also remove the internal design
docs that are currently cited by the code (`REALIGNMENT/`,
`docs/observability.md`, `docs/rtk-architecture.md`, `wiki/plans/`) —
that requires scrubbing ~15–20 in-code citations so nothing dangles, so
it's deliberately deferred.
- Untracked local working files (`benchmarks/hf_pilot/`,
`tools/copilot-test/`) are intentionally left out of git (not
committed).
2026-06-27 23:32:54 -07:00

255 lines
3.8 KiB
Text
Raw Blame History

# fastembed model cache (auto-downloaded ONNX weights, ~30 MB+).
# Should NEVER be committed — bloats the repo significantly.
.fastembed_cache/
**/.fastembed_cache/
# Local Kompress ONNX export artifacts (scripts/export_kompress_v2_onnx.py).
# Hundreds of MB each — published to HuggingFace, never committed.
/onnx/
# Private scripts (contain credentials). Allowlist checked-in helpers below.
scripts/
!scripts/
scripts/*
!scripts/install.sh
!scripts/install.ps1
!scripts/version-sync.py
!scripts/sync-plugin-versions.py
!scripts/changelog-gen.py
!scripts/verify-versions.py
!scripts/pr-governance.py
!scripts/tests/
!scripts/README.md
!scripts/repro_codex_replay.py
!scripts/eval_output_shaper.py
!scripts/fixtures/
!scripts/fixtures/*.json
!scripts/record_fixtures.py
!scripts/build_rust_extension.sh
!scripts/install-git-hooks.sh
!scripts/smoke_issue_327.py
!scripts/refresh_model_limits.sh
!scripts/audit_wheel_glibc_symbols.py
!scripts/replay_codex_ws_load.py
!scripts/export_kompress_v2_onnx.py
# Rust / Cargo build artifacts
/target/
**/target/
Cargo.lock.bak
# Swift SDK (separate repo)
swift/
# Local planning docs (never commit)
ENTERPRISE_HARDENING.md
# Audit/scan outputs (contain security findings — never commit)
bandit_result.txt
pip_audit_result.txt
ruff_result.txt
reqs.txt
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
pytest_cache/
# Translations
*.mo
*.pot
# Environments
.env
.env.*
!.env.act.example
!.env.example
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
.python-version
# Node.js dependencies (never commit vendored deps)
node_modules/
# Secrets and API keys - NEVER commit these
*.pem
*.key
secrets.json
credentials.json
.secrets
api_keys.txt
.anthropic
.openai
# IDE and editors
.idea/
.vscode/
*.swp
*.swo
*~
.project
.pydevproject
.settings/
*.sublime-project
*.sublime-workspace
.spyproject
.spyderproject
# Jupyter Notebook
.ipynb_checkpoints
*.ipynb
# macOS
.DS_Store
.AppleDouble
.LSOverride
._*
# Thumbnails
Icon?
._*
# Windows
Thumbs.db
ehthumbs.db
Desktop.ini
# Linux
*~
# Local configuration
local_settings.py
*.local.py
*.local.json
*.local.yaml
# Database files
*.db
*.sqlite
*.sqlite3
# Log files
*.log
logs/
log/
# Temporary files
tmp/
temp/
*.tmp
*.bak
*.swp
# Benchmark results (keep framework, not results)
.benchmarks/
benchmark_results.json
benchmark_results/
# DeepEval cache
.deepeval/
# Headroom specific
.headroom/
headroom.db
headroom_*.db
*.jsonl
!tests/fixtures/*.jsonl
docker/differential-network-capture/captures/
# Documentation build
docs/_build/
site/
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Ruff
.ruff_cache/
# pyright
pyrightconfig.json
# Editor backup files
*~
\#*\#
.\#*
# Local development configuration
CLAUDE.md
# Vitals provenance data
.vitals/
# Separate private repos — never commit here
headroom-managed/
# Local act testing (never commit test tokens)
/.env.act
.actrc.local
# Release metadata artifact
.releaseetadata
# uv lockfile: regenerated locally; not committed
uv.lock
# Rust extension `.so` symlinks placed by `scripts/build_rust_extension.sh`
# into the `headroom/` package dir for local development. The real binary
# lives in `crates/headroom-py/python/headroom/`; this is the dev overlay
# that lets `import headroom._core` resolve when the source `headroom/`
# package shadows the maturin overlay on sys.path.
/headroom/_core.*.so
/headroom/_core.so
.tokensave
Reference in a new issue View git blame Copy permalink