docs: align website contributing guide with root (#1980) - #1996
Merged
igorls merged 1 commit intoAug 15, 2026
Conversation
mvalentsev
marked this pull request as ready for review
July 11, 2026 13:39
mvalentsev
force-pushed
the
docs/1980-contributing-parity
branch
from
July 22, 2026 09:36
4f4d5b0 to
8bd95ca
Compare
mvalentsev
force-pushed
the
docs/1980-contributing-parity
branch
from
August 2, 2026 21:41
8bd95ca to
ca6d955
Compare
The website copy of the contributing guide had drifted from the authoritative root CONTRIBUTING.md, sending contributors down paths that create avoidable triage load: - PR target said `main`; the repo merges PRs into `develop` (`main` is tagged releases only). This is the contradiction reported in MemPalace#1980. - Getting Started cloned the upstream repo directly, with no fork and no upstream remote, contradicting the "Fork the repo" step below it. - The `pre-commit install` step was missing entirely, so the ruff version pin CI enforces never got set up locally: code passes local lint, then fails CI on push. Bring the setup steps and PR target into parity with root. Fixes MemPalace#1980 Co-authored-by: et1975 <623703+et1975@users.noreply.github.com>
mvalentsev
force-pushed
the
docs/1980-contributing-parity
branch
from
August 11, 2026 20:57
ca6d955 to
d9bae30
Compare
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
2 participants
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.
What does this PR do?
Fixes #1980.
The website copy of the contributing guide (
website/reference/contributing.md)had drifted from the authoritative root
CONTRIBUTING.md. Beyond the branchcontradiction in #1980, two more setup steps were out of sync, and all three
push contributors toward the "avoidable triage load" the report describes:
main. Contributions merge intodevelop;mainholds tagged productionreleases only (per the
ROADMAP.mdbranch model), so a PR against it getsre-targeted or closed.
MemPalace/mempalacedirectly, with no fork andno
upstreamremote. That contradicts the "Fork the repo" step further downthe same page.
pre-commit installwas absent. That step installs the hook pinning ruffto CI's exact version; without it a contributor's code passes local lint and
then fails CI on push.
Root
CONTRIBUTING.mdwas already correct and is untouched. Only the websitecopy changed.
How to test
grep -n "PR against" CONTRIBUTING.md website/reference/contributing.mdnowshows
developin both.Checklist
ruff check .scope unchanged)