docs: add CONTRIBUTING.md to .github with lifecycle diagram and stand#210
Open
vjuliaife wants to merge 18 commits into
Open
Conversation
…ards Creates .github/CONTRIBUTING.md as the primary GitHub-surfaced contributor guide. Includes a 3-step local setup, an end-to-end Mermaid data lifecycle diagram (Stellar Network → Soroban RPC → Event Indexer → Translation Engine → PostgreSQL/WebSocket → Frontend Dashboard), condensed coding standards, commit format, PR procedures, and a pre-PR checklist. Closes Open-audit-foundation#102
- lib/retention/policy.ts: loads RETENTION_DAYS, RETENTION_BATCH_SIZE, RETENTION_ARCHIVE_DIR, RETENTION_CRON, RETENTION_ENABLED, RETENTION_DRY_RUN from env with safe defaults; exposes getCutoffTimestamp() - lib/retention/archiver.ts: batches aged Event rows into gzip-compressed CSV flat-files (RFC 4180) using Node built-in zlib; returns ArchiveResult manifest per batch; no-op in dry-run mode - lib/retention/pruner.ts: cursor-paginated archive→delete loop bounded by batchSize; emits structured PrunerCycleResult log per cycle; logs VACUUM advisory after deletions; schedulePruner() registers node-cron task - lib/retention/__tests__/retention.test.ts: 14 tests covering policy loading, cutoff math, CSV format/escaping, gzip validity, dry-run guard, pruner batch logic, error isolation, and result shape - scripts/retention.ts: CLI for manual invocation and audit dry-runs; supports --dry-run, --days, --batch-size, --archive-dir flags - server.ts: wires schedulePruner() into the app startup path - package.json: adds dotenv dep, @types/dotenv and @types/node-cron dev deps; adds retention and retention:dry-run npm scripts - .env.example: documents all six RETENTION_* variables with defaults - docker-compose.yml: injects RETENTION_* env vars; adds archive_data named volume so CSV archives persist outside the container
…ompliance across the log viewer grid
…ompliance across the log viewer grid
…-core-ingestion Add captive core ingestion with resilient fallback
…nhance_accessibility_a11y ui(dashboard): Enhance accessibility (a11y) and keyboard navigation compliance across the log viewer grid
…s-retention-archival feat(retention): configurable event archival and pruner cron
…emory Custom V8 Garbage Collection Tuning and Memory Profiling
…nd standards" This reverts commit 9ef640d.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
issues)
(network layer) → Event Indexer (parsing worker) → Translation Engine → PostgreSQL + WebSocket (parallel paths) →
Frontend Dashboard
"spin up in 3 steps" acceptance criterion
((): ), PR procedures, and a pre-PR validation checklist in one place
What was resolved
GitHub's standard markdown interface
streaming pipeline
Closes #102