Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Bug report
description: Report a reproducible Breakcheck defect
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Before posting, remove private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts from every field and attachment.
- type: input
id: version_breakcheck
attributes:
label: Breakcheck version
description: Which Breakcheck version produced this result?
placeholder: 2.0.0
validations:
required: true
- type: input
id: python_version
attributes:
label: Python version
description: Include the exact supported Python version.
placeholder: 3.12.4
validations:
required: true
- type: dropdown
id: operating_system
attributes:
label: Operating system
options:
- Linux
- macOS
validations:
required: true
- type: dropdown
id: mode
attributes:
label: Breakcheck mode
description: Which workflow produced the defect?
options:
- Dependency comparison
- Revision diff
- Baseline freeze
- Claim attestation
- Demo or capabilities
- Other
validations:
required: true
- type: textarea
id: sanitized_context
attributes:
label: Sanitized comparison context
description: If relevant, name safe package versions, revision refs, target symbols, or claim type. Do not paste private source or repository details.
- type: textarea
id: sanitized_command
attributes:
label: Sanitized command
description: Paste the command after removing private paths, credentials, literals, and outputs.
render: shell
validations:
required: true
- type: textarea
id: reproduction_steps
attributes:
label: Reproduction steps
description: List the smallest safe steps that reproduce the issue.
validations:
required: true
- type: textarea
id: observed_behavior
attributes:
label: Observed behavior
description: What did Breakcheck report or do?
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: What should Breakcheck have reported or done?
validations:
required: true
- type: checkboxes
id: privacy_confirmation
attributes:
label: Privacy and security confirmation
options:
- label: I removed private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts before posting.
required: true
validations:
required: true
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/compatibility-case.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Compatibility case
description: Report a dependency upgrade compatibility case
title: "[Compatibility]: "
labels:
- compatibility
body:
- type: markdown
attributes:
value: |
Before posting, remove private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts from every field and attachment.
- type: input
id: version_breakcheck
attributes:
label: Breakcheck version
description: Which Breakcheck version produced this result?
placeholder: 2.0.0
validations:
required: true
- type: input
id: python_version
attributes:
label: Python version
description: Include the exact supported Python version.
placeholder: 3.12.4
validations:
required: true
- type: dropdown
id: operating_system
attributes:
label: Operating system
options:
- Linux
- macOS
validations:
required: true
- type: input
id: package_name
attributes:
label: Package name
description: Name of the dependency being compared.
validations:
required: true
- type: input
id: current_version
attributes:
label: Current package version
description: Version currently installed in the comparison environment.
validations:
required: true
- type: input
id: proposed_version
attributes:
label: Proposed package version
description: Version being evaluated for the upgrade.
validations:
required: true
- type: textarea
id: sanitized_command
attributes:
label: Sanitized command
description: Paste the command after removing private paths, credentials, literals, and outputs.
render: shell
validations:
required: true
- type: textarea
id: reproduction_steps
attributes:
label: Reproduction steps
description: List the smallest safe steps that reproduce the compatibility case.
validations:
required: true
- type: textarea
id: observed_behavior
attributes:
label: Observed behavior
description: What changed between the current and proposed versions?
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: What compatibility behavior did you expect?
validations:
required: true
- type: checkboxes
id: privacy_confirmation
attributes:
label: Privacy and security confirmation
options:
- label: I removed private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts before posting.
required: true
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Private security advisory
url: https://github.com/lovettsendit/breakcheck/security/advisories/new
about: Report security vulnerabilities privately.
- name: Read the README
url: https://github.com/lovettsendit/breakcheck#readme
about: Review scope, limitations, and usage before opening an issue.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature request
description: Suggest a focused improvement to Breakcheck
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Before posting, remove private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts from every field and attachment.
- type: textarea
id: problem
attributes:
label: Problem to solve
description: What user problem or workflow gap should this address?
validations:
required: true
- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: Describe the smallest useful change.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: What other approaches or workarounds have you considered?
validations:
required: true
- type: checkboxes
id: privacy_confirmation
attributes:
label: Privacy and security confirmation
options:
- label: I removed private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts before posting.
required: true
validations:
required: true
116 changes: 116 additions & 0 deletions .github/ISSUE_TEMPLATE/revision-claim-case.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
name: Revision or claim verification case
description: Report a sanitized diff, freeze, or attest result that needs investigation
title: "[Verification]: "
labels:
- verification
body:
- type: markdown
attributes:
value: |
Before posting, remove private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts from every field and attachment. Report verdicts exactly: `CLAIM_UNVERIFIABLE` is not success, and `CHANGED` does not mean bad.
- type: input
id: version_breakcheck
attributes:
label: Breakcheck version
description: Which Breakcheck version produced this result?
placeholder: 2.0.0
validations:
required: true
- type: input
id: python_version
attributes:
label: Python version
description: Include the exact supported Python version.
placeholder: 3.12.4
validations:
required: true
- type: dropdown
id: operating_system
attributes:
label: Operating system
options:
- Linux
- macOS
validations:
required: true
- type: dropdown
id: mode
attributes:
label: Verification mode
options:
- Revision diff
- Baseline freeze
- Claim attestation
validations:
required: true
- type: input
id: base_revision
attributes:
label: Sanitized base revision
description: Provide a public commit ID or a safe placeholder that still reproduces the case.
validations:
required: true
- type: input
id: head_revision
attributes:
label: Sanitized head revision or baseline
description: Provide a public commit ID, worktree, or baseline identifier without private paths.
validations:
required: true
- type: textarea
id: target_symbols
attributes:
label: Sanitized target symbols
description: List only public or safely renamed module and symbol names.
validations:
required: true
- type: dropdown
id: fixture_source
attributes:
label: Fixture source
description: State which revision supplied the fixtures used for verification.
options:
- Base revision
- Head revision
- Explicit fixture file
- No fixtures
validations:
required: true
- type: textarea
id: sanitized_command
attributes:
label: Sanitized command
description: Paste the command after removing private paths, credentials, literals, and outputs.
render: shell
validations:
required: true
- type: textarea
id: reproduction_steps
attributes:
label: Reproduction steps
description: List the smallest safe steps that reproduce the verification case.
validations:
required: true
- type: textarea
id: observed_behavior
attributes:
label: Observed verdicts
description: Include exact sanitized verdict names such as CLAIM_VERIFIED, CLAIM_REFUTED, CLAIM_UNVERIFIABLE, or CLAIM_OUT_OF_SCOPE and the reported coverage.
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: Explain the expected comparison or refusal without asserting that intentional change is a defect.
validations:
required: true
- type: checkboxes
id: privacy_confirmation
attributes:
label: Privacy and security confirmation
options:
- label: I removed private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts before posting.
required: true
validations:
required: true
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Linked issue

<!-- Link the issue this pull request addresses, for example: Closes #123. -->

## Smallest change

- [ ] This pull request is the smallest change that solves the linked issue.

## Regression test evidence

- [ ] I added or updated a regression test where behavior changed.
- [ ] I ran the relevant tests and included the command and result below.

Test command and result:

## Preserved counterexample

- [ ] Existing counterexamples and refusal behavior remain preserved.
- [ ] If this changes a counterexample, I documented why and included evidence.

## Privacy/security

- [ ] I removed private paths, private source, literals, outputs, credentials, and `.breakcheck/` artifacts from the pull request.
- [ ] I considered security and privacy impact.

## Docs/changelog

- [ ] I updated the documentation and changelog when user-visible behavior changed.
- [ ] No documentation or changelog update is needed, because:

## Breaking/release assessment

- [ ] This is not a breaking change.
- [ ] I assessed release impact, including versioning and migration notes where applicable.

Breaking/release assessment:
Loading