Blame for site/contributing.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Contributing &amp; Development Guidelines - Q-TensorFormer</title>
  <meta name="description" content="Guidelines for contributing to the Q-TensorFormer open-source research project, including test execution and scientific integrity rules.">
  <link rel="canonical" href="https://premchan369.github.io/Q-TensorFormer/contributing.html">
  
  <meta property="og:type" content="article">
  <meta property="og:site_name" content="Q-TensorFormer Research Project">
  <meta property="og:title" content="Contributing &amp; Development Guidelines - Q-TensorFormer">
  <meta property="og:description" content="Development workflow, testing standards, and pull request guidelines.">
  <meta property="og:url" content="https://premchan369.github.io/Q-TensorFormer/contributing.html">

  <script type="application/ld+json">
  {
    "@context": "https://schema.org",
    "@type": "TechArticle",
    "headline": "Q-TensorFormer Open-Source Contribution Guidelines",
    "description": "Standards for contributing code, running test gates, and maintaining scientific integrity.",
    "url": "https://premchan369.github.io/Q-TensorFormer/contributing.html",
    "author": { "@type": "Person", "name": "Premchand Yadav" },
    "datePublished": "2026-10-13"
  }
  </script>
  <link rel="stylesheet" href="assets/style.css">
</head>
<body>
  <header>
    <div class="header-container">
      <div class="logo">
        <a href="index.html"><span>Q-TensorFormer</span> Research</a>
      </div>
      <nav>
        <a href="index.html">Overview</a>
        <a href="architecture.html">Architecture</a>
        <a href="methodology.html">Methodology</a>
        <a href="benchmarks.html">Benchmarks</a>
        <a href="edge-inference.html">Edge Inference</a>
        <a href="training.html">Training</a>
        <a href="documentation.html">Docs & API</a>
        <a href="research.html">Research</a>
        <a href="limitations.html">Limitations</a>
        <a href="contributing.html" class="active">Contributing</a>
      </nav>
    </div>
  </header>

  <main class="container">
    <h1>Contributing &amp; Development Guidelines</h1>
    <p class="lead">
      We welcome contributions from researchers, ML systems engineers, and open-source developers. To maintain reproducibility, all contributions must satisfy strict verification standards.
    </p>

    <section>
      <h2>1. Non-Negotiable Scientific Principles</h2>
      <div class="callout warning">
        <ul>
          <li><strong>Zero Fabricated Metrics:</strong> Never submit synthetic benchmarks, simulated energy labeled as measured, or unverified hardware speedups.</li>
          <li><strong>Strict Checkpoint Loading:</strong> Never introduce <code>strict=False</code> bypasses or silent fallbacks to random weights.</li>
          <li><strong>Canonical Project Name:</strong> Maintain the canonical name <strong>Q-TensorFormer</strong>. Do not introduce versioned forks (e.g. v2, v3).</li>
        </ul>
      </div>
    </section>

    <section>
      <h2>2. Development Environment Setup</h2>
      <p>Fork the repository, clone locally, and create a clean Python virtual environment:</p>
      <pre><code>git clone https://huggingface.co/Premchan369/Q-TensorFormer
cd Q-TensorFormer
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt</code></pre>
    </section>

    <section>
      <h2>3. Required Pre-Commit Verification Gate</h2>
      <p>Before submitting any Pull Request, you must verify that all automated checks pass locally:</p>
      <pre><code># 1. Run full unit test suite (must report 0 failures)
pytest -v

# 2. Run deterministic smoke test
python scripts/smoke_test.py

# 3. Run scientific integrity auditor
python scripts/scientific_integrity_checker.py</code></pre>
    </section>

    <section>
      <h2>4. Code Style &amp; Engineering Standards</h2>
      <ul>
        <li><strong>Python Version:</strong> Tested on Python 3.10 and 3.11. Avoid deprecated language features.</li>
        <li><strong>Docstrings &amp; Comments:</strong> Preserve documentation integrity. Explain non-obvious mathematical rationale.</li>
        <li><strong>Tensor Operations:</strong> Ensure numerical stability. Avoid bare divisions and use <code>masked_fill</code> rather than <code>mask * float("-inf")</code>.</li>
      </ul>
    </section>

    <section>
      <h2>5. How to Submit a Pull Request</h2>
      <ol>
        <li>Create a descriptive topic branch (e.g. <code>git checkout -b feat/triton-fused-kernel</code>).</li>
        <li>Commit atomic, well-documented changes.</li>
        <li>Push to your fork and open a Pull Request against <code>main</code> on the Hugging Face repository.</li>
      </ol>
    </section>
  </main>

  <footer>
    <div class="footer-links">
      <a href="index.html">Home</a>
      <a href="architecture.html">Architecture</a>
      <a href="methodology.html">Methodology</a>
      <a href="benchmarks.html">Benchmarks</a>
      <a href="documentation.html">Docs</a>
      <a href="limitations.html">Limitations</a>
      <a href="sitemap.xml">Sitemap</a>
      <a href="llms.txt">llms.txt</a>
      <a href="https://huggingface.co/Premchan369/Q-TensorFormer">Hugging Face</a>
    </div>
    <p>&copy; 2026 Premchand Yadav. Licensed under Apache-2.0.</p>
  </footer>
</body>
</html>