[docs] keep reference files in the issue, not designs/ (unblock common contributor PR failure) - #40
Merged
Merged
Conversation
GETTING_STARTED and WALKTHROUGH both showed 'git add designs/my_family' with no note that the family dir must hold only the package — so a contributor who saved the datasheet/drawing/photo next to their design staged them, and family-pr-checks rejects reference files in designs/ (e.g. PR #36 committed a PDF+SVG+JPG). State the 'refs live in the issue' convention where contributors actually read it; it was only in CONTRIBUTING's gate table and a PR-template comment before. Signed-off-by: BenchCAD <benchcad@users.noreply.github.com>
HaozheZhang6
approved these changes
Jul 22, 2026
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.
Closes the doc gap behind the most common external-PR rejection.
Why
family-pr-checksrejects reference files insidedesigns/<family>/(only thepackage —
part.py/spec.py/family.json/NOTES.md+preview_*.png— isallowed; drawings/photos/datasheets belong in the issue). But the two docs a
new contributor actually reads first —
GETTING_STARTED.md(Path 1) andWALKTHROUGH.md— both showgit add designs/my_familywith no mention ofthis. So a contributor who saved the datasheet next to their design staged it and
hit a red gate with no obvious cause. Real example: PR #36 committed
gn705_standard_sheet.pdf+gn705_engineering_drawing.svg+gn705_product_photo.jpginto the family dir — its design passes
bench2 validate, it fails only on this.The convention was previously only in CONTRIBUTING's (dense) hard-gates table and
a PR-template HTML comment.
Change
One line each in
GETTING_STARTED.md(Submit) andWALKTHROUGH.md: the family dirholds only the package; datasheet/drawing/photo stay in the issue, not
designs/.Docs-only; pairs with the fork-feedback work in #39.