Adds all gitignores & READMEs

This commit is contained in:
Dandaedre 2026-09-15 15:15:36 +02:00
parent f06d954d8c
commit 387db6100d
5 changed files with 284 additions and 5 deletions

223
.gitignore vendored Normal file
View File

@ -0,0 +1,223 @@
# =============================================================================
# Beffroi Reporting — .gitignore
# =============================================================================
#
# This workspace contains source code, report definitions, diagnostic evidence
# and Git submodules.
#
# IMPORTANT:
# Do not globally ignore *.json, *.yaml, *.log, *.txt, etc.
# These may be intentional diagnostic/report evidence.
# =============================================================================
# -----------------------------------------------------------------------------
# Operating systems
# -----------------------------------------------------------------------------
.DS_Store
.AppleDouble
.LSOverride
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
Desktop.ini
$RECYCLE.BIN/
# -----------------------------------------------------------------------------
# Editors / IDEs
# -----------------------------------------------------------------------------
.idea/
.vscode/
*.swp
*.swo
*.swn
*~
.#*
*.code-workspace
# -----------------------------------------------------------------------------
# Temporary files
# -----------------------------------------------------------------------------
*.tmp
*.temp
*.bak
*.old
*.orig
tmp/
temp/
.tmp/
.cache/
# -----------------------------------------------------------------------------
# Python
# -----------------------------------------------------------------------------
**pycache**/
*.py[cod]
*$py.class
.venv/
venv/
env/
.pytest_cache/
.mypy_cache/
.ruff_cache/
.pyright/
.coverage
.coverage.*
htmlcov/
dist/
build/
*.egg-info/
# -----------------------------------------------------------------------------
# uv / Python tooling
# -----------------------------------------------------------------------------
#
# uv.lock is intentionally NOT ignored.
# It should normally be committed for reproducible tooling.
#
.python-version
# -----------------------------------------------------------------------------
# Rust
# -----------------------------------------------------------------------------
target/
# Cargo.lock is intentionally NOT ignored.
# Applications/tools should generally commit it.
# -----------------------------------------------------------------------------
# Typst
# -----------------------------------------------------------------------------
#
# Typst source files and assets are tracked.
# Generated PDFs should normally go into build/ or output/.
#
*.typst.tmp
# -----------------------------------------------------------------------------
# Generated output
# -----------------------------------------------------------------------------
output/
outputs/
out/
artifacts/
# Prefer generating PDFs into one of the directories above.
#
# Do NOT globally ignore *.pdf because archived reports may intentionally
# be committed to beffroi-reports.
# -----------------------------------------------------------------------------
# Diagnostic scratch data
# -----------------------------------------------------------------------------
#
# Canonical evidence belongs in reports/incidents/... and should be tracked.
# Only explicitly temporary collection directories are ignored.
#
scratch/
work/
working/
diagnostics-tmp/
collection-tmp/
# -----------------------------------------------------------------------------
# Runtime files
# -----------------------------------------------------------------------------
*.pid
*.pid.lock
*.stackdump
# -----------------------------------------------------------------------------
# Local configuration / secrets
# -----------------------------------------------------------------------------
.env
.env.*
!.env.example
*.secret
*.secrets
secrets/
.local/
# Local overrides should never be required for reproducibility.
config.local.*
*.local.yaml
*.local.yml
*.local.json
*.local.toml
# -----------------------------------------------------------------------------
# Credentials / certificates
# -----------------------------------------------------------------------------
*.key
*.pem
*.p12
*.pfx
credentials/
credentials.json
# -----------------------------------------------------------------------------
# Test / coverage output
# -----------------------------------------------------------------------------
coverage/
test-results/
junit.xml
# -----------------------------------------------------------------------------
# Packaging / archives
# -----------------------------------------------------------------------------
*.zip
*.tar
*.tar.gz
*.tgz
*.7z
# -----------------------------------------------------------------------------
# Miscellaneous
# -----------------------------------------------------------------------------
nohup.out
core
core.*
# =============================================================================
# DO NOT ADD GLOBAL RULES FOR:
#
# *.json
# *.yaml
# *.yml
# *.toml
# *.csv
# *.log
# *.txt
# *.md
# *.pdf
#
# These formats may represent intentional reports, evidence, schemas,
# configuration or archived deliverables.
#
# Ignore generated instances by DIRECTORY instead.
# =============================================================================

View File

@ -1,3 +1,59 @@
# beffroi-reporting
# Beffroi Reporting
Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Beffroi Reporting is the **integration workspace** for the Beffroi diagnostics and reporting toolchain.
It brings the complete environment together as Git submodules:
```text id="8efkt6"
beffroi-reporting
├── diagnostics/ → win-diagnostics
├── reports/ → beffroi-reports
└── reporter/ → reportist
```
During migration, the previous implementations are also available under `references/` so developers and agents can inspect the complete old and new workflows from one workspace.
The target pipeline is:
```text id="z3j03k"
Windows
↓
win-diagnostics
↓
diagnostic.json
↓
beffroi-reports
↓
report.yaml
↓
reportist
↓
PDF
```
## Getting started
Clone the complete workspace with its submodules:
```bash id="0mzx8u"
git clone --recursive <repository-url>
cd beffroi-reporting
```
For an existing checkout:
```bash id="ihk4op"
git submodule update --init --recursive
```
## Status
🚧 **Architecture migration in progress**
`AGENTS-TASKS.md` contains the migration roadmap. `AGENT.md` defines repository ownership and rules for agents working across the workspace.
## License
Root-level software and orchestration code is licensed under the **MIT License**.
Internal Beffroi data and content remain proprietary where applicable; see `LICENSE-DATA.md`.

@ -1 +1 @@
Subproject commit 79395367f68efdbc0a25cb1f37727ae6304daf45
Subproject commit 1db79172785f4455773c0eb69640cebc4488583f

@ -1 +1 @@
Subproject commit 8b94966d26a09e378ddd0e67f346dd2140b61260
Subproject commit d33bb4a16fccec5b280802972933992c6490a1f0

@ -1 +1 @@
Subproject commit 2b07888e8efc7b1f91523afa069ca61fdf5c263e
Subproject commit 84736d004e89f39d0b02ba7b9bf4d60022546329