Skip to content

Docs: bug-report template and first-contribution guide - #16

Merged
borek504 merged 1 commit into
mainfrom
docs-contributor-onboarding
Sep 15, 2026
Merged

borek504 merged 1 commit into
mainfrom
docs-contributor-onboarding

Conversation

@borek504

Copy link
Copy Markdown
Owner

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

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.

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.
@borek504 borek504 added the documentation Improvements or additions to documentation label Sep 15, 2026 — with ChatGPT Codex Connector

Copy link
Copy Markdown
Owner Author

Checkpoint: contributor package prepared

Candidate c42fb460b09b61e3edfab156c985378f50d8872e has three documentation/template changes only. The published blobs match the locally checked UTF-8/Markdown/YAML files; the Python sources, tests and workflow remain unchanged.

Both jobs of the PR-triggered workflow 34971414949 completed with success: Python 3.12 and 3.13. In each job, the existing contract-test step, demo-test step and Quick Start command succeeded. This round checked job/step results, not full log contents; it does not claim additional tests, UI rendering or external security review.

The three first-contribution issues #13/#14/#15 are already public, open and labelled good first issue. No contributor has been assigned and these tasks have not been performed by this PR. Their acceptance criteria are deliberately bounded.

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 borek504 left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@borek504
borek504 merged commit 4ac84e7 into main Sep 15, 2026
4 checks passed

Copy link
Copy Markdown
Owner Author

Merged and post-merge checks — 2026-09-15

Accepted after explicit maintainer approval and internal review as 4ac84e7cf6de2d2e95ac1c58d97d292d4faa90f3. The merge has parents f0b98b7e8df01944ca2ccd6a38015865ff18b021 and the reviewed head c42fb460b09b61e3edfab156c985378f50d8872e; tree 5ada5ca52e45edfe93c9d9ef105c6f75487e1462 is the submitted documentation candidate.

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 .github/ISSUE_TEMPLATE/bug_report.md (blob d4ef9d899a6df64c4c5989a06f1ff05175ab9e3e) and config.yml (blob e0ab1369003ffd88655dffd080d2f3e5ae0f2af9); the updated CONTRIBUTING guide was also read from main. The template has the required name/about front matter. Config retains blank issues and the Security reporting guidance / Start contributing links. This is a Markdown issue template, not a form that enforces required fields.

UI verification remains unconfirmed: an attempt to open the actual /issues/new/choose page failed in the web reader (cache miss); a separate read-only HTTP attempt could not resolve the hostname. No live chooser or prefilled editor was inspected and no test issue was submitted. Configuration/source checks must not be described as a successful interactive UI test. Expected manual check: Issues → New issue → “Bug report (synthetic reproducer)”, then verify the [Bug] title and reproduction sections without submitting an empty issue.

The published v0.1.0-alpha.1 tag was read again and still points to f0b98b7e8df01944ca2ccd6a38015865ff18b021. No release/tag movement, validator/demo/test/workflow changes, contributor reassignment, merge of #4/#10, or private-system work were performed. Contributor issues #13–#15 are not resolved by this documentation merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant