Skip to content

<a class="headerlink" href="#_1" title="Permanent link">¶</a></h1> <p><strong>story_id</strong>: <code>CVN-N<nnn>-US<m></code> <strong>epic_id</strong>: <code>CVN-N<nnn>-E<letter></code> (parent) <strong>need_id</strong>: <code>CVN-N<nnn></code> (grand-parent) <strong>Status</strong>: <code>draft | in-progress | done | cancelled</code> <strong>Created</strong>: YYYY-MM-DD <strong>Size</strong>: <code>XS | S | M | L | XL</code> (effort estimate)</p> <hr /> <h2 id="1-user-story">1. User story<a class="headerlink" href="#1-user-story" title="Permanent link">¶</a></h2> <blockquote> <p>As a <strong><role></strong>, I want <strong><capability></strong> so that <strong><benefit></strong>.</p> </blockquote> <h2 id="2-context">2. Context<a class="headerlink" href="#2-context" title="Permanent link">¶</a></h2> <p><Short paragraph connecting this story to the parent epic. Why now? What's the prior state?></p> <h2 id="3-acceptance-criteria">3. Acceptance criteria<a class="headerlink" href="#3-acceptance-criteria" title="Permanent link">¶</a></h2> <p><Specific, testable, observable. The CI / reviewer checks these to mark done.></p> <ul class="task-list"> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Criterion 1 (testable: how is it verified?)</li> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Criterion 2</li> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Tests added: <code><file paths></code> — scenario list</li> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Documentation updated: <code><file paths></code></li> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> No ADR violated (scan <code>documentation/adr/</code>)</li> </ul> <h2 id="4-test-plan">4. Test plan<a class="headerlink" href="#4-test-plan" title="Permanent link">¶</a></h2> <p><What tests are added/modified? Unit? Integration? Manual verification steps for the operator?></p> <ul> <li>Unit tests: <code>tests/unit/<file>.py::<class></code></li> <li>Integration: <code>tests/integration/<file>.py</code></li> <li>Manual: <code><steps for operator post-merge></code></li> </ul> <h2 id="5-dependencies">5. Dependencies<a class="headerlink" href="#5-dependencies" title="Permanent link">¶</a></h2> <p><Other stories this requires. External data / credentials / deploys.></p> <ul> <li>Depends on: <code><story_id / external></code></li> </ul> <h2 id="6-prs">6. PRs<a class="headerlink" href="#6-prs" title="Permanent link">¶</a></h2> <p><Updated as PRs land. Multiple PRs per story is normal.></p> <ul> <li>PR #<n> — <title> — <code><commit_sha_short></code></li> </ul> <h2 id="7-mlflow-runs-if-this-story-triggers-model-training">7. MLflow runs (if this story triggers model training)<a class="headerlink" href="#7-mlflow-runs-if-this-story-triggers-model-training" title="Permanent link">¶</a></h2> <p><Filled when training runs happen under this story. Carries need_id / epic_id / story_id tags.></p> <ul> <li>Run <code><uuid></code> — <code><params highlight></code> — metric <code><f1_buy=x></code> — status <code><ok/bad></code></li> </ul> <h2 id="8-closure">8. Closure<a class="headerlink" href="#8-closure" title="Permanent link">¶</a></h2> <p><Filled when done. Outcome, links to merged PRs, metric before/after, any lesson learned.></p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../TEMPLATE_epic/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Epic"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footer__title"> <span class="md-footer__direction"> Previous </span> <div class="md-ellipsis"> Epic </div> </div> </a> <a href="../TEMPLATE_design/" class="md-footer__link md-footer__link--next" aria-label="Next: Design doc"> <div class="md-footer__title"> <span class="md-footer__direction"> Next </span> <div class="md-ellipsis"> Design doc </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> </div> <div class="md-social"> <a href="https://github.com/dococeven/champollion" target="_blank" rel="noopener" title="github.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.footer", "search.suggest", "search.highlight", "content.code.copy", "content.action.edit", "toc.follow"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script> </body> </html>