docs: add CONTRIBUTING.md (baselines vs optimizers, PR hygiene) - #46
Open
quint-mbbdigital wants to merge 2 commits into
Open
docs: add CONTRIBUTING.md (baselines vs optimizers, PR hygiene)#46quint-mbbdigital wants to merge 2 commits into
quint-mbbdigital wants to merge 2 commits into
Conversation
Root contributor guide: branch from main, baseline/ vs optimizers/ separation, OPTIMIZER_VARIANTS pointer, pytest/CI expectations. Class A docs only.
Fork is the no-push-access path only; collaborators branch on this repo. Layout and integrity expectations apply to both roles.
Author
|
Update: CONTRIBUTING now delineates external (fork path) vs write-access collaborator (branch on this repo) vs maintainer. Fork is permissions, not social rank. Layout/integrity expectations still apply to any PR author. |
quint-mbbdigital
marked this pull request as ready for review
August 10, 2026 19:39
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.
Type
Summary
Add a root
CONTRIBUTING.mdcovering fork/PR workflow, baseline vsoptimizers/*separation, link toOPTIMIZER_VARIANTS.md, and light pytest/CI expectations. Link from the root README.Why
No root CONTRIBUTING guide existed. Contributors need a clear “do not mix baseline and intervention lanes” pointer.
Definition surface
None (docs only). Mentions α=2 only as boundary language in a “don’t” table.
Test plan
Out of scope
Optimizer mathematics, defaults, new packages.