Repository navigation
Docs: bug-report template and first-contribution guide - #16
Conversation
Link three bounded first-contribution issues, keep blank issues available, and route sensitive reports to the existing security policy. Documentation and issue-template files only; validator, demo, tests, CI and release source are unchanged.
Checkpoint: contributor package preparedCandidate Both jobs of the PR-triggered workflow 34971414949 completed with The three first-contribution issues #13/#14/#15 are already public, open and labelled The issue template is proposed here, not yet active in the default-branch New issue chooser. Its activation still requires normal review and merge. No merge, release or tag change was performed, and the existing v2/evidence-store review gates are unaffected. |
borek504
left a comment
There was a problem hiding this comment.
Internal maintainer review after explicit approval to accept this documentation-only PR. Reviewed the complete three-file diff and PR discussion at head c42fb46 against main f0b98b7. The Markdown issue template has the required name/about front matter, an optional [Bug] title, a synthetic-reproducer structure and the existing security-policy link. The chooser configuration preserves blank issues and adds guidance links without automatic assignees. CONTRIBUTING distinguishes documentation, coverage and behavior changes, and tells contributors to check issue status before starting. No Python source, test, workflow, profile, release or tag changes are included. PR workflow 34971414949 for this exact head is completed/success. No blocking finding in this narrow review. This is internal review, not independent security acceptance for #4 or #10. After merge, verify default-branch files and the New issue chooser; a source check alone is not a claim that the interactive UI was tested. Issues #13–#15 are not resolved by this merge; #15 remains assigned to its contributor.
Merged and post-merge checks — 2026-09-15Accepted after explicit maintainer approval and internal review as New main-push workflow 34972612734 completed successfully. Both Python 3.12/3.13 jobs and their contract-test, demo-test and Quick Start steps report success. This round verified run/job/step metadata, not new full log contents or additional tests. Post-merge default-branch reads confirm UI verification remains unconfirmed: an attempt to open the actual The published |
Purpose
Make it easier for a first-time contributor to report a useful problem or pick a small task after the initial alpha release. This is a documentation/community change, not another validator component.
Three-file scope
.github/ISSUE_TEMPLATE/bug_report.md: asks for the exact version, environment, minimal synthetic reproduction, expected behavior and observed output. A proposed fix is optional; sensitive findings are routed to the existing security policy..github/ISSUE_TEMPLATE/config.yml: keeps blank issues available and links to security/contribution guidance. No automatic assignees or reviewer tags.CONTRIBUTING.md: a short starting path, commands, links to First contribution: check Quick Start on one macOS or Windows setup #13/First contribution: add a short glossary for the existing validator #14/First contribution: test nested-list isolation in the demo fixtures #15, and a distinction between documentation-only, test-coverage and behavior-changing contributions.The three new issues are already open and labelled
good first issue: one-platform Quick Start report, a short glossary, and nested-list demo-fixture tests. They are invitations, not completed work or reviewer commitments. This PR does not resolve those issues.Checks and boundaries
Base:
f0b98b7e8df01944ca2ccd6a38015865ff18b021.Candidate:
c42fb460b09b61e3edfab156c985378f50d8872e.Locally checked UTF-8, Markdown fences/whitespace, required template front matter, YAML configuration types and referenced issue numbers. The three submitted file blobs match the checked local copies. The validator, demo, both Python test files, CI workflow, README, profile, license and security policy have unchanged blob identities.
Remote CI is not yet claimed at PR creation. Local syntax checks are not a GitHub UI-rendering test. GitHub makes an issue template available through the normal New issue chooser only after it is merged into the default branch: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
No merge, tag movement, new release, dependency, runtime operation or code change is included. The v2 and evidence-store review requirements in #9/#11 remain separate; these beginner tasks do not satisfy them. Prepared with AI assistance.