Skip to content

docs: add CONTRIBUTING.md to .github with lifecycle diagram and stand…#149

Open
vjuliaife wants to merge 3 commits into
Open-audit-foundation:mainfrom
vjuliaife:main
Open

docs: add CONTRIBUTING.md to .github with lifecycle diagram and stand…#149
vjuliaife wants to merge 3 commits into
Open-audit-foundation:mainfrom
vjuliaife:main

Conversation

@vjuliaife

Copy link
Copy Markdown

Summary

  • Creates .github/CONTRIBUTING.md — GitHub's primary contributor guide location (surfaced automatically on new PRs and
    issues)
  • Adds an end-to-end Mermaid data lifecycle diagram tracing the full event journey: Stellar Network → Soroban RPC
    (network layer) → Event Indexer (parsing worker) → Translation Engine → PostgreSQL + WebSocket (parallel paths) →
    Frontend Dashboard
  • Documents 3-step local setup (git clone + npm install → cp .env.example .env.local → npm run dev:ws) satisfying the
    "spin up in 3 steps" acceptance criterion
  • Consolidates team style guidelines (function declarations, no any, naming conventions), commit format
    ((): ), PR procedures, and a pre-PR validation checklist in one place
  • No existing files modified — root CONTRIBUTING.md and ARCHITECTURE.md are preserved and linked from the new file

What was resolved

  • Mermaid diagram uses flowchart TB syntax consistent with the existing ARCHITECTURE.md, which renders correctly on
    GitHub's standard markdown interface
  • PostgreSQL is correctly shown as a parallel persistence branch (via app/api/ routes), not in the real-time WebSocket
    streaming pipeline
  • .env.example was confirmed to exist, so Step 2 works out of the box

Closes #102

Screenshot 2026-06-20 at 6 32 42 AM Screenshot 2026-06-20 at 6 33 03 AM Screenshot 2026-06-20 at 6 33 23 AM Screenshot 2026-06-20 at 6 33 49 AM Screenshot 2026-06-20 at 6 34 10 AM Screenshot 2026-06-20 at 6 34 32 AM Screenshot 2026-06-20 at 6 34 56 AM Screenshot 2026-06-20 at 6 35 02 AM Screenshot 2026-06-20 at 6 35 10 AM Screenshot 2026-06-20 at 6 35 16 AM Screenshot 2026-06-20 at 6 35 23 AM

…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
@Osuochasam

Copy link
Copy Markdown
Collaborator

@vjuliaife switch branch, your pushing to my main branch

@vjuliaife

Copy link
Copy Markdown
Author

@vjuliaife switch branch, your pushing to my main branch

There is no dev branch or any other branch that looks better to push to, i had to push to main. By the way, you have been merging other works on main branch.

Please create a branch i can create the pr to. I had to create another pr to this branch #210

let me know which works for you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Author a comprehensive CONTRIBUTING.md guide featuring interactive architecture system mapping

2 participants