mirror of
https://github.com/nesquena/hermes-webui.git
synced 2026-05-25 19:20:16 +00:00
nesquena-hermes
0c26ab3425
Two follow-ups from Opus pre-release review of stage-336: 1. tests/conftest.py — autouse session fixture that removes HERMES_WEBUI_SKIP_ONBOARDING from os.environ for the whole pytest run, and restores it after. Hosting providers and isolated harnesses set this var to short-circuit the onboarding wizard, but it leaked into pytest and caused tests that exercise apply_onboarding_setup() to fail with cryptic FileNotFoundError. Tests that specifically validate the short-circuit behavior can opt back in with monkeypatch.setenv. Surgical per-test delenv calls remain as defense-in-depth but are now redundant. 2. docs/rfcs/README.md — one-line note that first-time contributor RFCs should be discussed in an issue before opening a PR. Gates drive-by design-doc PRs without us having to decline them on contribution. Verified: 96 onboarding-related tests pass with HERMES_WEBUI_SKIP_ONBOARDING=1 exported in the test runner env (would have failed before this fixture).
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# RFCs
|
|
|
|
This directory holds design documents for hermes-webui features that are
|
|
worth thinking through in writing before (or alongside) implementation —
|
|
typically when the change touches durability, recovery, schema, or cross-
|
|
cutting infrastructure.
|
|
|
|
## Conventions
|
|
|
|
- One file per RFC. Filename is the topic (kebab-case), not a number.
|
|
- Top of every RFC carries a small header:
|
|
|
|
- **Status:** Proposed | Accepted | Implemented | Withdrawn
|
|
- **Author:** @github-handle
|
|
- **Created:** YYYY-MM-DD
|
|
|
|
- Sections usually include: Problem, Goals, Non-goals, Proposal, Open
|
|
questions, Rollout plan. Skip what doesn't apply.
|
|
- An RFC is a starting point for review. Comments and revisions land via PR
|
|
edits, not separate discussion threads.
|
|
|
|
## When to file an RFC
|
|
|
|
- The change is large enough that you want consensus before writing code.
|
|
- The change touches data-at-rest formats or recovery semantics.
|
|
- The change introduces a new architectural primitive (journal, queue,
|
|
scheduler, cache layer) that other features will build on.
|
|
- A reviewer asks for one during code review.
|
|
|
|
When in doubt, just ship the code — small features don't need RFCs.
|
|
First-time contributor RFCs should be discussed in an issue before opening a PR.
|
|
|
|
## Current RFCs
|
|
|
|
- [`turn-journal.md`](turn-journal.md) — Crash-safe WebUI turn journal for
|
|
recovering interrupted chat submissions.
|