Contributing to Geode | Geode Database

<h2 id="contributing-to-geode" class="position-relative d-flex align-items-center group"> Contributing to Geode <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="contributing-to-geode" aria-haspopup="dialog" aria-label="Share link: Contributing to Geode"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Thank you for your interest in contributing to Geode! This guide will help you get started. <h3 id="ways-to-contribute" class="position-relative d-flex align-items-center group"> Ways to Contribute <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="ways-to-contribute" aria-haspopup="dialog" aria-label="Share link: Ways to Contribute"> Share link </button> </h3> <h4 id="code-contributions" class="position-relative d-flex align-items-center group"> Code Contributions <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-contributions" aria-haspopup="dialog" aria-label="Share link: Code Contributions"> Share link </button> </h4><ul> <li>Implement new features</li> <li>Fix bugs and issues</li> <li>Improve performance</li> <li>Add tests</li> </ul> <h4 id="documentation" class="position-relative d-flex align-items-center group"> Documentation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="documentation" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4><ul> <li>Write tutorials and guides</li> <li>Improve API documentation</li> <li>Fix typos and clarify examples</li> <li>Translate documentation</li> </ul> <h4 id="testing" class="position-relative d-flex align-items-center group"> Testing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="testing" aria-haspopup="dialog" aria-label="Share link: Testing"> Share link </button> </h4><ul> <li>Report bugs</li> <li>Write test cases</li> <li>Perform load testing</li> <li>Test on different platforms</li> </ul> <h4 id="community" class="position-relative d-flex align-items-center group"> Community <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="community" aria-haspopup="dialog" aria-label="Share link: Community"> Share link </button> </h4><ul> <li>Answer questions</li> <li>Help other users</li> <li>Share use cases</li> <li>Write blog posts</li> </ul> <h3 id="getting-started" class="position-relative d-flex align-items-center group"> Getting Started <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="getting-started" aria-haspopup="dialog" aria-label="Share link: Getting Started"> Share link </button> </h3> <h4 id="1-setup-development-environment" class="position-relative d-flex align-items-center group"> 1. Setup Development Environment <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="1-setup-development-environment" aria-haspopup="dialog" aria-label="Share link: 1. Setup Development Environment"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone repository git clone https://github.com/codeprosorg/geode cd geode # Install Zig 0.1.0+ # Download from https://ziglang.org/download/ # Build zig build # Run tests zig build test # Run comprehensive tests python3 scripts/test/extended_test_runner.py </code></pre></div> <h4 id="2-find-something-to-work-on" class="position-relative d-flex align-items-center group"> 2. Find Something to Work On <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-find-something-to-work-on" aria-haspopup="dialog" aria-label="Share link: 2. Find Something to Work On"> Share link </button> </h4><ul> <li>Good First Issues: Look for <code>good-first-issue</code> label</li> <li>Help Wanted: Check <code>help-wanted</code> label</li> <li>Bug Reports: Browse open issues</li> <li>Feature Requests: Review enhancement proposals</li> </ul> <h4 id="3-create-a-branch" class="position-relative d-flex align-items-center group"> 3. Create a Branch <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="3-create-a-branch" aria-haspopup="dialog" aria-label="Share link: 3. Create a Branch"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create feature branch git checkout -b feature/your-feature-name # Or bug fix branch git checkout -b fix/issue-123-description </code></pre></div> <h3 id="code-contribution-guidelines" class="position-relative d-flex align-items-center group"> Code Contribution Guidelines <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-contribution-guidelines" aria-haspopup="dialog" aria-label="Share link: Code Contribution Guidelines"> Share link </button> </h3> <h4 id="code-standards" class="position-relative d-flex align-items-center group"> Code Standards <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-standards" aria-haspopup="dialog" aria-label="Share link: Code Standards"> Share link </button> </h4>Zig Code Style: <ul> <li>Follow Zig style guide</li> <li>Use meaningful variable names</li> <li>Add comments for complex logic</li> <li>Keep functions focused and small</li> </ul> Example: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// Good pub fn calculatePageRank( graph: *Graph, iterations: u32, damping_factor: f64, ) !PageRankResult { // Implementation } // Bad pub fn calc(g: *Graph, i: u32, d: f64) !PR { // Implementation } </code></pre></div> <h4 id="canary-markers" class="position-relative d-flex align-items-center group"> CANARY Markers <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="canary-markers" aria-haspopup="dialog" aria-label="Share link: CANARY Markers"> Share link </button> </h4>All implementations must include CANARY markers for governance tracking: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// CANARY: REQ=REQ-XXX; FEATURE="PageRank"; ASPECT=Algorithm; STATUS=TESTED; TEST=TestPageRankBasic; OWNER=graph; UPDATED=2026-01-24 pub fn pageRank(graph: *Graph, config: PageRankConfig) !Result { // Implementation } </code></pre></div>CANARY Format: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">// CANARY: REQ=REQ-XXX; FEATURE="Name"; ASPECT=Aspect; STATUS=IMPL; TEST=TestName; OWNER=team; UPDATED=YYYY-MM-DD </code></pre></div>Statuses: <code>TESTED</code>, <code>BENCHED</code>, <code>IMPL</code>, <code>EXEMPT</code> <h4 id="testing-requirements" class="position-relative d-flex align-items-center group"> Testing Requirements <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="testing-requirements" aria-haspopup="dialog" aria-label="Share link: Testing Requirements"> Share link </button> </h4>Every code change must include tests: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">test "PageRank: basic graph" { const allocator = std.testing.allocator; // Setup var graph = try Graph.init(allocator); defer graph.deinit(); // Test implementation const result = try pageRank(&graph, .{ .iterations = 20, .damping_factor = 0.85, }); // Assertions try std.testing.expectApproxEqAbs(0.38, result.scores[0], 0.01); } </code></pre></div>Test Coverage Requirements: <ul> <li>Unit tests for new functions</li> <li>Integration tests for features</li> <li> <blockquote> 90% code coverage maintained </blockquote> </li> </ul> <h4 id="commit-messages" class="position-relative d-flex align-items-center group"> Commit Messages <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="commit-messages" aria-haspopup="dialog" aria-label="Share link: Commit Messages"> Share link </button> </h4>Follow conventional commit format: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><type>(<scope>): <subject> <body> <footer> </code></pre></div>Types: <code>feat</code>, <code>fix</code>, <code>docs</code>, <code>test</code>, <code>refactor</code>, <code>perf</code>, <code>chore</code> Examples: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">feat(query): Add PageRank graph algorithm Implements PageRank algorithm with configurable damping factor and iteration count. Includes HNSW index integration. CANARY: REQ=REQ-XXX; FEATURE="PageRank"; ASPECT=Algorithm; STATUS=TESTED; TEST=TestPageRankBasic; OWNER=graph; UPDATED=2026-01-24 Closes #123 fix(storage): Resolve WAL corruption on crash Fixed race condition in WAL sync that could cause corruption during ungraceful shutdown. CANARY: REQ=REQ-XXX; FEATURE="WAL"; ASPECT=CrashRecovery; STATUS=TESTED; TEST=TestWalCrashRecovery; OWNER=storage; UPDATED=2026-01-24 Fixes #456 </code></pre></div> <h3 id="pull-request-process" class="position-relative d-flex align-items-center group"> Pull Request Process <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="pull-request-process" aria-haspopup="dialog" aria-label="Share link: Pull Request Process"> Share link </button> </h3> <h4 id="1-create-pull-request" class="position-relative d-flex align-items-center group"> 1. Create Pull Request <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="1-create-pull-request" aria-haspopup="dialog" aria-label="Share link: 1. Create Pull Request"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Push branch git push origin feature/your-feature-name # Create PR on GitLab # Title: Brief description (50 chars) # Description: Detailed explanation with: # - What changed # - Why the change was needed # - How to test # - Related issues </code></pre></div> <h4 id="2-pr-template" class="position-relative d-flex align-items-center group"> 2. PR Template <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-pr-template" aria-haspopup="dialog" aria-label="Share link: 2. PR Template"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown">## Description Brief summary of changes ## Motivation Why is this change needed? ## Changes - Added feature X - Fixed bug Y - Updated documentation Z ## Testing - [ ] Unit tests added - [ ] Integration tests pass - [ ] Manual testing performed ## Checklist - [ ] Code follows style guidelines - [ ] CANARY markers added - [ ] Tests added/updated - [ ] Documentation updated - [ ] Commit messages follow format ## Related Issues Closes #123 Relates to #456 </code></pre></div> <h4 id="3-code-review" class="position-relative d-flex align-items-center group"> 3. Code Review <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="3-code-review" aria-haspopup="dialog" aria-label="Share link: 3. Code Review"> Share link </button> </h4>Expect feedback on: <ul> <li>Code quality and style</li> <li>Test coverage</li> <li>Performance implications</li> <li>Documentation</li> <li>Security considerations</li> </ul> Responding to Feedback: <ul> <li>Be open to suggestions</li> <li>Ask questions if unclear</li> <li>Make requested changes</li> <li>Update PR description if scope changes</li> </ul> <h4 id="4-merge-requirements" class="position-relative d-flex align-items-center group"> 4. Merge Requirements <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="4-merge-requirements" aria-haspopup="dialog" aria-label="Share link: 4. Merge Requirements"> Share link </button> </h4>Before merge, PR must: <ul> <li>✅ Pass all CI checks</li> <li>✅ Have >90% test coverage</li> <li>✅ Be approved by maintainer</li> <li>✅ Have no merge conflicts</li> <li>✅ Include CANARY markers</li> <li>✅ Update documentation</li> </ul> <h3 id="documentation-contributions" class="position-relative d-flex align-items-center group"> Documentation Contributions <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="documentation-contributions" aria-haspopup="dialog" aria-label="Share link: Documentation Contributions"> Share link </button> </h3> <h4 id="documentation-structure" class="position-relative d-flex align-items-center group"> Documentation Structure <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="documentation-structure" aria-haspopup="dialog" aria-label="Share link: Documentation Structure"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode/docs/ # Markdown documentation geodedb.com/ # Hugo static site content/docs/ # User-facing documentation tutorials/ # Step-by-step guides guides/ # How-to guides reference/ # API reference use-cases/ # Domain examples </code></pre></div> <h4 id="writing-documentation" class="position-relative d-flex align-items-center group"> Writing Documentation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="writing-documentation" aria-haspopup="dialog" aria-label="Share link: Writing Documentation"> Share link </button> </h4>Style Guide: <ul> <li>Use active voice</li> <li>Keep sentences short (<25 words)</li> <li>Provide code examples</li> <li>Include expected output</li> <li>Add troubleshooting section</li> </ul> Example Structure: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"># Page Title Brief introduction (2-3 sentences) ## Prerequisites - Requirement 1 - Requirement 2 ## Step-by-Step Guide ### Step 1: First Action \```gql -- Code example CREATE (:Node {property: value}); \``` **Expected output**: \``` Created 1 node \``` ### Step 2: Next Action ... ## Troubleshooting **Problem**: Common issue **Solution**: How to resolve ## Next Steps - [Related Guide](/docs/guides/) - [Tutorial](/docs/tutorials/) </code></pre></div> <h4 id="documentation-pr" class="position-relative d-flex align-items-center group"> Documentation PR <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="documentation-pr" aria-haspopup="dialog" aria-label="Share link: Documentation PR"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Documentation changes git checkout -b docs/improve-transaction-guide # Make changes vim geodedb.com/content/docs/tutorials/transactions.md # Commit git commit -m "docs(tutorials): Improve transaction examples" # Push and create PR git push origin docs/improve-transaction-guide </code></pre></div> <h3 id="bug-reports" class="position-relative d-flex align-items-center group"> Bug Reports <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="bug-reports" aria-haspopup="dialog" aria-label="Share link: Bug Reports"> Share link </button> </h3> <h4 id="before-reporting" class="position-relative d-flex align-items-center group"> Before Reporting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="before-reporting" aria-haspopup="dialog" aria-label="Share link: Before Reporting"> Share link </button> </h4><ol> <li>Search existing issues: Check if already reported</li> <li>Verify reproduction: Ensure it’s reproducible</li> <li>Check version: Test on latest version</li> <li>Gather information: Collect logs and environment details</li> </ol> <h4 id="bug-report-template" class="position-relative d-flex align-items-center group"> Bug Report Template <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="bug-report-template" aria-haspopup="dialog" aria-label="Share link: Bug Report Template"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown">## Bug Description Clear, concise description of the bug ## Steps to Reproduce 1. Start Geode server 2. Execute query: `MATCH (n) RETURN n` 3. Observe error ## Expected Behavior What should happen ## Actual Behavior What actually happens ## Environment - Geode version: 0.2.18 - OS: Ubuntu 22.04 - Zig version: 0.1.0 - Client library: Python 0.3.19 ## Logs \``` [ERROR] Stack trace... \``` ## Additional Context Any other relevant information </code></pre></div> <h3 id="feature-requests" class="position-relative d-flex align-items-center group"> Feature Requests <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="feature-requests" aria-haspopup="dialog" aria-label="Share link: Feature Requests"> Share link </button> </h3> <h4 id="feature-request-template" class="position-relative d-flex align-items-center group"> Feature Request Template <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="feature-request-template" aria-haspopup="dialog" aria-label="Share link: Feature Request Template"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown">## Feature Description What feature are you proposing? ## Motivation Why is this feature needed? What problem does it solve? ## Proposed Solution How should this be implemented? ## Alternatives Considered What other solutions were considered? ## Additional Context - Related features - Use cases - Examples from other systems </code></pre></div> <h3 id="community-guidelines" class="position-relative d-flex align-items-center group"> Community Guidelines <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="community-guidelines" aria-haspopup="dialog" aria-label="Share link: Community Guidelines"> Share link </button> </h3> <h4 id="code-of-conduct" class="position-relative d-flex align-items-center group"> Code of Conduct <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-of-conduct" aria-haspopup="dialog" aria-label="Share link: Code of Conduct"> Share link </button> </h4><ul> <li>Be respectful: Treat everyone with respect</li> <li>Be collaborative: Work together constructively</li> <li>Be inclusive: Welcome diverse perspectives</li> <li>Be patient: Help newcomers learn</li> </ul> <h4 id="communication-channels" class="position-relative d-flex align-items-center group"> Communication Channels <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="communication-channels" aria-haspopup="dialog" aria-label="Share link: Communication Channels"> Share link </button> </h4><ul> <li>GitLab Issues: Bug reports, feature requests</li> <li>GitLab Merge Requests: Code review</li> <li>Discussions: General questions and ideas</li> <li>Email: <a href="mailto:[email protected]" >[email protected]</a> (security issues only)</li> </ul> <h3 id="development-workflow" class="position-relative d-flex align-items-center group"> Development Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="development-workflow" aria-haspopup="dialog" aria-label="Share link: Development Workflow"> Share link </button> </h3> <h4 id="typical-workflow" class="position-relative d-flex align-items-center group"> Typical Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="typical-workflow" aria-haspopup="dialog" aria-label="Share link: Typical Workflow"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Sync with main git checkout main git pull origin main # 2. Create branch git checkout -b feature/my-feature # 3. Make changes vim src/feature.zig # 4. Add tests vim src/feature_test.zig # 5. Run tests zig build test # 6. Commit git add . git commit -m "feat: Add my feature" # 7. Push git push origin feature/my-feature # 8. Create PR # (via GitLab web interface) # 9. Address review feedback # (update code, push again) # 10. Merge # (maintainer merges after approval) </code></pre></div> <h4 id="cicd-pipeline" class="position-relative d-flex align-items-center group"> CI/CD Pipeline <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="cicd-pipeline" aria-haspopup="dialog" aria-label="Share link: CI/CD Pipeline"> Share link </button> </h4>All PRs run through CI: <ol> <li>Build: Compile on multiple platforms</li> <li>Test: Run full test suite (>1,600 tests)</li> <li>Lint: Check code style</li> <li>Coverage: Verify >90% coverage</li> <li>Benchmark: Run performance tests</li> <li>Documentation: Build docs site</li> </ol> <h3 id="license" class="position-relative d-flex align-items-center group"> License <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="license" aria-haspopup="dialog" aria-label="Share link: License"> Share link </button> </h3>By contributing, you agree that your contributions will be licensed under the Apache License 2.0. <h3 id="recognition" class="position-relative d-flex align-items-center group"> Recognition <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="recognition" aria-haspopup="dialog" aria-label="Share link: Recognition"> Share link </button> </h3>Contributors are recognized in: <ul> <li><code>CONTRIBUTORS.md</code> file</li> <li>Release notes</li> <li>Git commit history</li> <li>Documentation co-authorship</li> </ul> <h3 id="getting-help" class="position-relative d-flex align-items-center group"> Getting Help <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="getting-help" aria-haspopup="dialog" aria-label="Share link: Getting Help"> Share link </button> </h3><ul> <li>Documentation: Read existing guides first</li> <li>Issues: Search for similar issues</li> <li>Discussions: Ask in GitLab discussions</li> <li>Code: Check existing implementations for examples</li> </ul> <h3 id="geode-test-lab" class="position-relative d-flex align-items-center group"> Geode Test Lab <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="geode-test-lab" aria-haspopup="dialog" aria-label="Share link: Geode Test Lab"> Share link </button> </h3>The Geode Test Lab provides a comprehensive testing environment for validating contributions before they’re merged. <h4 id="test-lab-overview" class="position-relative d-flex align-items-center group"> Test Lab Overview <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="test-lab-overview" aria-haspopup="dialog" aria-label="Share link: Test Lab Overview"> Share link </button> </h4>The test lab runs automatically on all merge requests and includes: <table> <thead> <tr> <th>Test Suite</th> <th>Duration</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Unit Tests</td> <td>~2 min</td> <td>Fast, isolated function tests</td> </tr> <tr> <td>Integration Tests</td> <td>~5 min</td> <td>Component interaction tests</td> </tr> <tr> <td>GQL Conformance</td> <td>~10 min</td> <td>ISO/IEC 39075:2024 compliance</td> </tr> <tr> <td>Client Tests</td> <td>~3 min</td> <td>Multi-language client validation</td> </tr> <tr> <td>Performance</td> <td>~15 min</td> <td>Benchmark regression detection</td> </tr> <tr> <td>Security Scan</td> <td>~5 min</td> <td>Static analysis and CVE checks</td> </tr> </tbody> </table> <h4 id="running-tests-locally" class="position-relative d-flex align-items-center group"> Running Tests Locally <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="running-tests-locally" aria-haspopup="dialog" aria-label="Share link: Running Tests Locally"> Share link </button> </h4>Before submitting a PR, run the test lab locally: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Navigate to the geode directory cd geode # Run unit tests (fast) make test # Run comprehensive test suite (97.4% pass rate expected) make geodetestlab-comprehensive # Run specific test categories zig build test -- --test-filter "storage" zig build test -- --test-filter "query" zig build test -- --test-filter "transaction" # Run GQL conformance tests make gql-conformance # Run performance benchmarks make benchmark </code></pre></div> <h4 id="test-lab-requirements" class="position-relative d-flex align-items-center group"> Test Lab Requirements <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="test-lab-requirements" aria-haspopup="dialog" aria-label="Share link: Test Lab Requirements"> Share link </button> </h4>Minimum Standards: <ul> <li>✅ 100% of existing tests must pass</li> <li>✅ New code must include tests</li> <li>✅ >90% code coverage maintained</li> <li>✅ No performance regressions (>5% degradation fails)</li> <li>✅ All CANARY markers properly formatted</li> </ul> <h4 id="test-categories" class="position-relative d-flex align-items-center group"> Test Categories <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="test-categories" aria-haspopup="dialog" aria-label="Share link: Test Categories"> Share link </button> </h4>1. Unit Tests (<code>test "..."</code> in Zig): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">test "Graph: add node with properties" { const allocator = std.testing.allocator; var graph = try Graph.init(allocator); defer graph.deinit(); const node = try graph.addNode("Person", .{ .name = "Alice", .age = @as(i64, 30), }); try std.testing.expectEqualStrings("Person", node.label); try std.testing.expectEqual(@as(i64, 30), node.getProperty("age").?.int); } </code></pre></div>2. Integration Tests: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run the integration test harness cd geode-test-harness make test-all </code></pre></div>3. Client Compatibility Tests: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Test all client libraries against the server cd geode-test-harness # Test specific language make test-go make test-python make test-rust make test-zig # Generate test reports make test-all-html </code></pre></div> <h4 id="ci-pipeline-stages" class="position-relative d-flex align-items-center group"> CI Pipeline Stages <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="ci-pipeline-stages" aria-haspopup="dialog" aria-label="Share link: CI Pipeline Stages"> Share link </button> </h4>When you push a commit, the CI pipeline runs: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">stages: - build - test-unit - test-integration - test-gql-conformance - test-clients - benchmark - security-scan - documentation </code></pre></div> <h4 id="viewing-test-results" class="position-relative d-flex align-items-center group"> Viewing Test Results <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="viewing-test-results" aria-haspopup="dialog" aria-label="Share link: Viewing Test Results"> Share link </button> </h4>Access test results: <ol> <li>GitLab CI: Click on the pipeline status badge</li> <li>Test Reports: Artifacts contain detailed HTML reports</li> <li>Coverage: View coverage report in artifacts</li> </ol> <h4 id="common-test-failures" class="position-relative d-flex align-items-center group"> Common Test Failures <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="common-test-failures" aria-haspopup="dialog" aria-label="Share link: Common Test Failures"> Share link </button> </h4><table> <thead> <tr> <th>Failure</th> <th>Cause</th> <th>Resolution</th> </tr> </thead> <tbody> <tr> <td><code>test_xxx FAILED</code></td> <td>Test logic error</td> <td>Fix implementation or test</td> </tr> <tr> <td><code>memory leak detected</code></td> <td>Zig allocator issue</td> <td>Use proper defer/deinit</td> </tr> <tr> <td><code>benchmark regression</code></td> <td>Performance degradation</td> <td>Optimize or justify change</td> </tr> <tr> <td><code>CANARY missing</code></td> <td>Missing governance marker</td> <td>Add CANARY comment</td> </tr> </tbody> </table> <h3 id="code-signing-for-contributors" class="position-relative d-flex align-items-center group"> Code Signing for Contributors <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-signing-for-contributors" aria-haspopup="dialog" aria-label="Share link: Code Signing for Contributors"> Share link </button> </h3>All commits to Geode must be signed. This ensures authenticity and prevents tampering. <h4 id="why-code-signing" class="position-relative d-flex align-items-center group"> Why Code Signing? <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="why-code-signing" aria-haspopup="dialog" aria-label="Share link: Why Code Signing?"> Share link </button> </h4><ul> <li>Authenticity: Proves commits come from you</li> <li>Integrity: Detects if commits are modified</li> <li>Compliance: Required for enterprise deployments</li> <li>Trust: Builds chain of trust in the codebase</li> </ul> <h4 id="setting-up-gpg-signing" class="position-relative d-flex align-items-center group"> Setting Up GPG Signing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="setting-up-gpg-signing" aria-haspopup="dialog" aria-label="Share link: Setting Up GPG Signing"> Share link </button> </h4>1. Generate GPG Key: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate new key pair gpg --full-generate-key # Recommended settings: # - Key type: RSA and RSA (default) # - Key size: 4096 bits # - Expiration: 1-2 years # - Real name: Your full name # - Email: Same as your Git email </code></pre></div>2. List Your Keys: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># List keys gpg --list-secret-keys --keyid-format=long # Output: # sec rsa4096/ABCD1234EFGH5678 2026-01-15 [SC] [expires: 2028-01-15] # 1234567890ABCDEF1234567890ABCDEF12345678 # uid [ultimate] Your Name <[email protected]> </code></pre></div>3. Configure Git: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Set signing key (use the key ID from step 2) git config --global user.signingkey ABCD1234EFGH5678 # Enable automatic signing git config --global commit.gpgsign true # Set GPG program (if needed) git config --global gpg.program gpg </code></pre></div>4. Export Public Key: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Export public key gpg --armor --export ABCD1234EFGH5678 > my-public-key.asc # Or copy to clipboard (macOS) gpg --armor --export ABCD1234EFGH5678 | pbcopy # Or copy to clipboard (Linux) gpg --armor --export ABCD1234EFGH5678 | xclip -selection clipboard </code></pre></div>5. Add Key to GitLab: <ol> <li>Go to GitLab > Preferences > GPG Keys</li> <li>Paste your public key</li> <li>Click “Add key”</li> </ol> <h4 id="using-ssh-signing-alternative" class="position-relative d-flex align-items-center group"> Using SSH Signing (Alternative) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="using-ssh-signing-alternative" aria-haspopup="dialog" aria-label="Share link: Using SSH Signing (Alternative)"> Share link </button> </h4>If you prefer SSH keys over GPG: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Configure SSH signing git config --global gpg.format ssh git config --global user.signingkey ~/.ssh/id_ed25519.pub # Enable automatic signing git config --global commit.gpgsign true </code></pre></div>Add your SSH key to GitLab: <ol> <li>Go to GitLab > Preferences > SSH Keys</li> <li>Check “Use this key for signing”</li> </ol> <h4 id="signing-commits" class="position-relative d-flex align-items-center group"> Signing Commits <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="signing-commits" aria-haspopup="dialog" aria-label="Share link: Signing Commits"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Sign a commit (if not automatic) git commit -S -m "feat: Add new feature" # Verify commit signature git log --show-signature -1 # Verify specific commit git verify-commit HEAD </code></pre></div> <h4 id="signing-tags" class="position-relative d-flex align-items-center group"> Signing Tags <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="signing-tags" aria-haspopup="dialog" aria-label="Share link: Signing Tags"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create signed tag git tag -s v1.0.0 -m "Release v1.0.0" # Verify tag signature git tag -v v1.0.0 </code></pre></div> <h4 id="troubleshooting-code-signing" class="position-relative d-flex align-items-center group"> Troubleshooting Code Signing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="troubleshooting-code-signing" aria-haspopup="dialog" aria-label="Share link: Troubleshooting Code Signing"> Share link </button> </h4>GPG agent not running: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start GPG agent gpgconf --launch gpg-agent # Or add to shell profile export GPG_TTY=$(tty) </code></pre></div>“Secret key not available”: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check key is available gpg --list-secret-keys # Ensure email matches Git config git config user.email # Must match GPG key email </code></pre></div>“Cannot sign commits” on macOS: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install pinentry-mac brew install pinentry-mac # Configure GPG echo "pinentry-program $(which pinentry-mac)" >> ~/.gnupg/gpg-agent.conf # Restart agent gpgconf --kill gpg-agent </code></pre></div>Verifying Setup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create test commit echo "test" > test.txt git add test.txt git commit -m "test: Verify code signing works" # Check signature git log --show-signature -1 # Should show: # gpg: Signature made [date] # gpg: Good signature from "Your Name <[email protected]>" </code></pre></div> <h3 id="contributor-vetting-process" class="position-relative d-flex align-items-center group"> Contributor Vetting Process <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="contributor-vetting-process" aria-haspopup="dialog" aria-label="Share link: Contributor Vetting Process"> Share link </button> </h3>Geode follows a formal vetting process for contributors to ensure code quality, security, and legal compliance. <h4 id="contributor-license-agreement-cla" class="position-relative d-flex align-items-center group"> Contributor License Agreement (CLA) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="contributor-license-agreement-cla" aria-haspopup="dialog" aria-label="Share link: Contributor License Agreement (CLA)"> Share link </button> </h4>All contributors must sign the Contributor License Agreement before their first contribution is accepted. Why a CLA? <ul> <li>Clarifies intellectual property rights</li> <li>Grants necessary permissions for code distribution</li> <li>Protects both contributors and the project</li> <li>Enables license compatibility</li> </ul> Signing the CLA: <ol> <li>First-time contributors: When you open your first PR, the CLA bot will prompt you</li> <li>Sign electronically: Click the link and complete the form</li> <li>Verify identity: Use the same email as your Git commits</li> <li>One-time process: Only required once per contributor</li> </ol> CLA Terms Summary: <ul> <li>You retain copyright of your contributions</li> <li>You grant perpetual license to use, modify, and distribute</li> <li>You confirm contributions are your original work</li> <li>You confirm you have the right to submit</li> </ul> <h4 id="third-party-developer-verification" class="position-relative d-flex align-items-center group"> Third-Party Developer Verification <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="third-party-developer-verification" aria-haspopup="dialog" aria-label="Share link: Third-Party Developer Verification"> Share link </button> </h4>For contributors from organizations or those with access to sensitive systems: Verification Levels: <table> <thead> <tr> <th>Level</th> <th>Requirements</th> <th>Access Granted</th> </tr> </thead> <tbody> <tr> <td>Standard</td> <td>CLA + Code signing</td> <td>General contributions</td> </tr> <tr> <td>Verified</td> <td>Standard + Identity verification</td> <td>Core system access</td> </tr> <tr> <td>Trusted</td> <td>Verified + Organization validation</td> <td>Security-sensitive code</td> </tr> </tbody> </table> Standard Verification: <ol> <li>Sign CLA</li> <li>Set up code signing (GPG/SSH)</li> <li>Maintain signed commit history</li> </ol> Identity Verification (for elevated access): <ol> <li>Complete standard verification</li> <li>Provide government-issued ID verification</li> <li>Pass background check (for enterprise contributors)</li> <li>Complete security awareness training</li> </ol> Organization Validation (for corporate contributors): <ol> <li>Organization signs corporate CLA</li> <li>Designated representative validates contributors</li> <li>Organization assumes responsibility for member contributions</li> </ol> <h4 id="certificate-signing-request-csr-verification" class="position-relative d-flex align-items-center group"> Certificate Signing Request (CSR) Verification <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="certificate-signing-request-csr-verification" aria-haspopup="dialog" aria-label="Share link: Certificate Signing Request (CSR) Verification"> Share link </button> </h4>For contributions to cryptographic or security-critical code: When CSR Verification is Required: <ul> <li>Authentication/authorization code changes</li> <li>Cryptographic implementations</li> <li>Key management system changes</li> <li>Certificate handling code</li> <li>TLS/mTLS implementations</li> </ul> CSR Process: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate private key (keep secure!) openssl genrsa -out contributor-private.key 4096 # Create Certificate Signing Request openssl req -new \ -key contributor-private.key \ -out contributor.csr \ -subj "/C=US/ST=State/L=City/O=Organization/OU=Development/[email protected]" # Submit CSR to [email protected] # Subject: CSR Submission for [GitLab Username] </code></pre></div>CSR Requirements: <ul> <li>4096-bit RSA or ED25519 key</li> <li>Matches registered email address</li> <li>Valid organization information</li> <li>No self-signed certificates</li> </ul> <h4 id="vetting-timeline" class="position-relative d-flex align-items-center group"> Vetting Timeline <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vetting-timeline" aria-haspopup="dialog" aria-label="Share link: Vetting Timeline"> Share link </button> </h4><table> <thead> <tr> <th>Step</th> <th>Duration</th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td>CLA signing</td> <td>Immediate</td> <td>Automated via CLA bot</td> </tr> <tr> <td>Code signing setup</td> <td>1-2 hours</td> <td>Self-service</td> </tr> <tr> <td>Identity verification</td> <td>1-3 business days</td> <td>Manual review</td> </tr> <tr> <td>Organization validation</td> <td>5-10 business days</td> <td>Requires corporate contact</td> </tr> <tr> <td>CSR verification</td> <td>2-5 business days</td> <td>Security team review</td> </tr> </tbody> </table> <h3 id="vulnerability-handling-for-maintainers" class="position-relative d-flex align-items-center group"> Vulnerability Handling for Maintainers <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vulnerability-handling-for-maintainers" aria-haspopup="dialog" aria-label="Share link: Vulnerability Handling for Maintainers"> Share link </button> </h3>This section documents the process for Geode team members handling security vulnerabilities. <h4 id="responsible-disclosure" class="position-relative d-flex align-items-center group"> Responsible Disclosure <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="responsible-disclosure" aria-haspopup="dialog" aria-label="Share link: Responsible Disclosure"> Share link </button> </h4>Receiving Vulnerability Reports: <ol> <li>Monitor <a href="mailto:[email protected]" >[email protected]</a> inbox</li> <li>Acknowledge receipt within 24 hours</li> <li>Assign CVE ID if applicable</li> <li>Begin triage within 48 hours</li> </ol> Vulnerability Classification: <table> <thead> <tr> <th>Severity</th> <th>CVSS Score</th> <th>Response Time</th> <th>Disclosure Timeline</th> </tr> </thead> <tbody> <tr> <td>Critical</td> <td>9.0-10.0</td> <td>24 hours</td> <td>7 days max</td> </tr> <tr> <td>High</td> <td>7.0-8.9</td> <td>72 hours</td> <td>30 days</td> </tr> <tr> <td>Medium</td> <td>4.0-6.9</td> <td>7 days</td> <td>60 days</td> </tr> <tr> <td>Low</td> <td>0.1-3.9</td> <td>30 days</td> <td>90 days</td> </tr> </tbody> </table> <h4 id="vulnerability-response-process" class="position-relative d-flex align-items-center group"> Vulnerability Response Process <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vulnerability-response-process" aria-haspopup="dialog" aria-label="Share link: Vulnerability Response Process"> Share link </button> </h4>Step 1: Triage <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown">## Vulnerability Triage Checklist - [ ] Vulnerability verified/reproduced - [ ] Severity assessed (CVSS score) - [ ] Affected versions identified - [ ] Attack vector documented - [ ] Impact assessment completed - [ ] CVE ID requested (if applicable) </code></pre></div>Step 2: Fix Development <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create private security branch git checkout -b security/CVE-YYYY-XXXXX # Develop fix in private # DO NOT push to public repository # Test fix thoroughly make test make security-scan </code></pre></div>Step 3: Patch Preparation <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Prepare patches for all affected versions git format-patch main # Create backport patches for LTS versions # v0.1.x, v0.1.x, v0.1.x </code></pre></div>Step 4: Coordinated Disclosure <ol> <li>Notify reporter: Confirm fix and disclosure timeline</li> <li>Prepare advisory: Draft security advisory</li> <li>Pre-notify: Inform enterprise customers (if applicable)</li> <li>Release fix: Publish patches to all branches</li> <li>Public disclosure: Publish advisory and CVE details</li> </ol> <h4 id="security-advisory-template" class="position-relative d-flex align-items-center group"> Security Advisory Template <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-advisory-template" aria-haspopup="dialog" aria-label="Share link: Security Advisory Template"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"># Security Advisory: [CVE-YYYY-XXXXX] ## Summary Brief description of the vulnerability ## Severity **CVSS Score**: X.X (Critical/High/Medium/Low) **Vector**: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H ## Affected Versions - Geode 0.2.0 - 0.2.18 - Geode 0.2.18 and earlier in the supported release line ## Fixed Versions - Geode 0.2.18 ## Description Detailed description of vulnerability and attack vector ## Mitigation Temporary workarounds if immediate upgrade not possible ## Credit Reporter name (if they consent to disclosure) ## Timeline - YYYY-MM-DD: Vulnerability reported - YYYY-MM-DD: Acknowledged - YYYY-MM-DD: Fix developed - YYYY-MM-DD: Patches released - YYYY-MM-DD: Public disclosure </code></pre></div> <h4 id="safely-removing-vulnerabilities-from-history" class="position-relative d-flex align-items-center group"> Safely Removing Vulnerabilities from History <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="safely-removing-vulnerabilities-from-history" aria-haspopup="dialog" aria-label="Share link: Safely Removing Vulnerabilities from History"> Share link </button> </h4>When to Remove from History: <ul> <li>Committed credentials or secrets</li> <li>Accidentally committed private keys</li> <li>Sensitive data in commits</li> </ul> Process: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># CAUTION: This rewrites history - coordinate with all team members # Use BFG Repo-Cleaner (preferred) java -jar bfg.jar --delete-files "*.pem" geode.git java -jar bfg.jar --replace-text passwords.txt geode.git # Or use git filter-repo git filter-repo --path-glob '*.key' --invert-paths # Force push (requires coordinated effort) git push origin --force --all git push origin --force --tags </code></pre></div>Post-Removal Actions: <ol> <li>Rotate credentials: All exposed secrets must be rotated</li> <li>Notify team: Inform all maintainers to re-clone</li> <li>Update CI: Regenerate CI tokens and secrets</li> <li>Audit access: Review who might have seen exposed data</li> <li>Document incident: Record in internal security log</li> </ol> <h4 id="security-scanning" class="position-relative d-flex align-items-center group"> Security Scanning <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-scanning" aria-haspopup="dialog" aria-label="Share link: Security Scanning"> Share link </button> </h4>Regular Security Tasks: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run daily security scan make security-scan # Check dependencies for CVEs zig fetch --check-vulnerabilities # Static analysis make lint-security # Generate SBOM (Software Bill of Materials) make sbom </code></pre></div>Automated Alerts: <ul> <li>GitLab dependency scanning</li> <li>SAST (Static Application Security Testing)</li> <li>Container scanning</li> <li>License compliance</li> </ul> <h4 id="security-contacts" class="position-relative d-flex align-items-center group"> Security Contacts <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-contacts" aria-haspopup="dialog" aria-label="Share link: Security Contacts"> Share link </button> </h4><table> <thead> <tr> <th>Role</th> <th>Contact</th> <th>Responsibility</th> </tr> </thead> <tbody> <tr> <td>Security Lead</td> <td><a href="mailto:[email protected]" >[email protected]</a> </td> <td>Overall security oversight</td> </tr> <tr> <td>Incident Response</td> <td><a href="mailto:[email protected]" >[email protected]</a> </td> <td>Active incident handling</td> </tr> <tr> <td>CVE Coordinator</td> <td><a href="mailto:[email protected]" >[email protected]</a> </td> <td>CVE assignments</td> </tr> </tbody> </table> <h3 id="advanced-topics" class="position-relative d-flex align-items-center group"> Advanced Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="advanced-topics" aria-haspopup="dialog" aria-label="Share link: Advanced Topics"> Share link </button> </h3> <h4 id="performance-optimization" class="position-relative d-flex align-items-center group"> Performance Optimization <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-optimization" aria-haspopup="dialog" aria-label="Share link: Performance Optimization"> Share link </button> </h4>When contributing performance improvements: <ol> <li>Benchmark first: Establish baseline</li> <li>Measure impact: Use <code>zig build bench</code></li> <li>Document results: Include before/after metrics</li> <li>Avoid premature optimization: Profile first</li> </ol> <h4 id="security" class="position-relative d-flex align-items-center group"> Security <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security" aria-haspopup="dialog" aria-label="Share link: Security"> Share link </button> </h4>Reporting Security Issues: <ul> <li>DO NOT open public issues</li> <li>Email: <a href="mailto:[email protected]" >[email protected]</a> </li> <li>Encrypt: Use PGP if possible</li> <li>Include: Detailed reproduction steps</li> </ul> Security Review: <ul> <li>All authentication/authorization changes reviewed by security team</li> <li>Cryptographic code requires expert review</li> <li>Input validation mandatory</li> </ul> <h3 id="resources" class="position-relative d-flex align-items-center group"> Resources <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="resources" aria-haspopup="dialog" aria-label="Share link: Resources"> Share link </button> </h3> <h4 id="documentation-1" class="position-relative d-flex align-items-center group"> Documentation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="documentation-1" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4><ul> <li><a href="/docs/architecture/" >Architecture Guide</a> </li> <li><a href="/docs/api-reference/" >API Reference</a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/-/blob/main/docs/TODO.md" aria-label="Development TODO – opens in new window" target="_blank" rel="noopener noreferrer" >Development TODO ↗ </a> </li> </ul> <h4 id="code" class="position-relative d-flex align-items-center group"> Code <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code" aria-haspopup="dialog" aria-label="Share link: Code"> Share link </button> </h4><ul> <li><a href="https://github.com/codeprosorg/geode" aria-label="Source Repository – opens in new window" target="_blank" rel="noopener noreferrer" >Source Repository ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/-/issues" aria-label="Issue Tracker – opens in new window" target="_blank" rel="noopener noreferrer" >Issue Tracker ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/-/pipelines" aria-label="Continuous Integration – opens in new window" target="_blank" rel="noopener noreferrer" >Continuous Integration ↗ </a> </li> </ul> <h4 id="community-1" class="position-relative d-flex align-items-center group"> Community <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="community-1" aria-haspopup="dialog" aria-label="Share link: Community"> Share link </button> </h4><ul> <li><a href="https://gitlab.com/devnw/codepros/geode/-/issues" aria-label="Discussions – opens in new window" target="_blank" rel="noopener noreferrer" >Discussions ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/-/graphs/main" aria-label="Contributors List – opens in new window" target="_blank" rel="noopener noreferrer" >Contributors List ↗ </a> </li> </ul> <h3 id="thank-you" class="position-relative d-flex align-items-center group"> Thank You <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="thank-you" aria-haspopup="dialog" aria-label="Share link: Thank You"> Share link </button> </h3>Your contributions make Geode better for everyone. We appreciate your time and effort! <hr> License: Apache License 2.0 Copyright: 2024-2025 CodePros Last Updated: January 2026