Offboarding - #175
Open
BeckettFrey wants to merge 3 commits into
Open
Conversation
Two offboarding-related changes. docs/ONBOARDING.md is written for whoever inherits the project. The existing docs cover structure (ARCHITECTURE), mechanics (BUILD, RELEASE), and agent workflows (AGENTS.md); this one covers what a successor is actually handed: the external footprint beyond this repo, the access they need before `uv sync` will even run, a first-week reading path, the failure modes that have already cost days, and the current state of the tree. Linked from the README appendix. Notable items it records, all verified against the tree rather than inferred: - `uv sync` needs read access to pkadambi/PyPhonemePronunciationScorer, which is private and owned outside both labs. It is a hard day-one blocker, so it leads the guide. - Two tests are red on macOS and Linux and have been since 2026-08-11. Cause is in the test, not the product: TestEnsureMfaServerRunning monkeypatches sys.platform to win32, which routes into _no_window() reading subprocess.CREATE_NO_WINDOW -- a constant that only exists on Windows. - The branching model has drifted from what CONTRIBUTING and RELEASE describe. Every PR since #162 targeted main directly, and develop is stale enough that merging it now would revert work. - The in-app Feedback button opens a mailto to a personal address in app_info.yaml. Flagged on the handover checklist. The speechbrain source moves from a personal account to BrainBehaviorAnalyticsLab, so that no runtime dependency is anchored to an individual once they leave. The org fork resolves to the same commit (a89d8ff), so uv.lock changes by URL only. TECH_DEBT RT-5 is updated to match: the fork is no longer personal, and two of the four forked dependencies now sit outside the org rather than three. RT-5 itself still stands -- all four sources declare a branch rather than a rev, and `invoke fresh-slate` deletes the lockfile that is currently the only thing pinning them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates project documentation and dependency configuration to improve maintainability and clarify onboarding. The most significant change is migrating the
speechbraindependency from a personal fork to an organization-owned repository, reducing external risk. Additionally, onboarding documentation is made more visible in theREADME.md.Dependency management improvements:
speechbraindependency inpyproject.tomlto use the organization-ownedBrainBehaviorAnalyticsLab/speechbrainrepository instead of the personal fork, improving long-term maintainability and reducing reliance on individual accounts.docs/TECH_DEBT.mdto reflect thatspeechbrainis now an org-owned fork, and clarified the risk assessment accordingly.Documentation improvements:
docs/ONBOARDING.md) at the top of theREADME.mdappendix to make it easier for new maintainers to get started.