docs: sync contributing rules and roadmap with CI and plans - #45
Merged
Conversation
Problem - CONTRIBUTING.md did not document the PR requirements that validate.yml enforces mechanically, so contributors learned about them only from failing CI. - README showed no PTN_BIND example despite highlighting it. - roadmap.md did not record the multi-subject matching direction or the syntax ideas that were evaluated and rejected. Implementation - CONTRIBUTING.md: document PR title format, required PR body sections (**Summary**/**Changes**/**Testing**), the one-commit-per- PR squash convention, and the mechanically checked commit subject rules (imperative mood, lowercase, no trailing period, 72-char body wrap). - README.md: add a self-contained structural match example using PTN_BIND named placeholders in a guard; verified compilable. - roadmap.md: note the PTN_BIND arity-10 workstream under WIP, add multi-subject matching (match(a, b) + tup(...)) under NEXT with its relation to some/none, and add a Considered and Declined section for guard operator!, member-call placeholders, chained comparisons, and deferred PTN_BIND Type validation. Tests - Docs-only change; the new README snippet was compiled and run against the current headers with GCC in C++17 mode.
sentomk
force-pushed
the
docs/contributing-roadmap-update
branch
from
August 1, 2026 06:18
f9a67cc to
48907e3
Compare
sentomk
added a commit
that referenced
this pull request
Aug 1, 2026
Problem - Branch protection requires the build-and-test and coverage checks from ci.yml, but its pull_request trigger ignored docs-only paths. - Docs-only PRs therefore never reported the required checks and were permanently blocked, e.g. PR #45 needed an admin override. Implementation - Drop paths-ignore from the pull_request trigger so the required checks always report; keep it on the push trigger to avoid burning CI on docs-only pushes to main. - Add a comment recording why the filter must stay off for PRs. Tests - YAML parses cleanly; the trigger change only affects when the workflow starts, not any job logic. - This PR itself touches .github/, so the full matrix runs and the required checks must report before merge.
sentomk
added a commit
that referenced
this pull request
Aug 1, 2026
Problem - Branch protection requires the build-and-test and coverage checks from ci.yml, but its pull_request trigger ignored docs-only paths. - Docs-only PRs therefore never reported the required checks and were permanently blocked, e.g. PR #45 needed an admin override. Implementation - Drop paths-ignore from the pull_request trigger so the required checks always report; keep it on the push trigger to avoid burning CI on docs-only pushes to main. - Add a comment recording why the filter must stay off for PRs. Tests - YAML parses cleanly; the trigger change only affects when the workflow starts, not any job logic. - This PR itself touches .github/, so the full matrix runs and the required checks must report before merge.
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.
Summary
Sync contributor-facing docs with reality:
CONTRIBUTING.mdnow documents the PR requirements thatvalidate.ymlenforces mechanically (previously only discoverable through failing CI),README.mdgains aPTN_BINDexample, anddocs/roadmap.mdrecords the multi-subject matching direction plus syntax ideas that were evaluated and rejected.Changes
CONTRIBUTING.md: document PR title format, required PR body sections (**Summary**/**Changes**/**Testing**, ≥50 chars), the one-commit-per-PR squash convention, and the mechanically checked commit subject rules (imperative mood, lowercase start, no trailing period, 72-char body wrap).README.md: add a self-contained structural match example usingPTN_BINDnamed placeholders in a guard.docs/roadmap.md: note thePTN_BINDarity-10 workstream under WIP (PR feat(dsl): extend PTN_BIND to 10 names via chained macros #44); add multi-subject matching (match(a, b)+tup(...)) under NEXT, including its shared slot-composition machinery withsome/none; add a "Considered and Declined" section covering guardoperator!, member-call placeholders, chained comparisons, and deferredPTN_BINDTypevalidation.Testing