Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorLeitwolf112026-09-26 13:02:51 +0300
committerLeitwolf112026-09-26 13:02:51 +0300
commit6e8e2fd83c5cf7d625b532580cfb896d6f5ead0b (patch)
tree3cc985417e564f0d34a293d5a2dcba49f653570d /.github
parentecf89607b787c10302c9e31b06ecda104791a617 (diff)
downloadcatch3-6e8e2fd83c5cf7d625b532580cfb896d6f5ead0b.tar.gz
Replace upstream Catch2 issue templates with Catch3-specific reports and security policy
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md50
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md32
2 files changed, 54 insertions, 28 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dbeff115..96d5d733 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,29 +1,41 @@
---
name: Bug report
-about: Create an issue that documents a bug
-title: ''
-labels: ''
-assignees: ''
-
+about: Report a reproducible problem in Progmasoft Catch3
+title: "[Bug] "
---
-**Describe the bug**
-A clear and concise description of what the bug is.
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-1.1 -->
+
+Before filing, check the latest code and [current limitations](https://github.com/Progmasoft/catch3/blob/devel/docs/why-catch3.md). Catch3 is an independent project, not an official Catch2 release. Please do not post credentials or private test data. Send security vulnerabilities privately to support@progmasoft.com.
+
+### Affected surface
+
+- [ ] Catch3 addition (property checks, snapshots, results, or XML)
+- [ ] Catch2-compatible runner, assertion, or reporter
+- [ ] Build, installation, or packaging
+- [ ] Documentation
+
+### What happened?
+
+Describe the observed behavior and include the exact failure message. If the issue concerns the compatibility engine, say whether it also reproduces with upstream Catch2.
+
+### What did you expect?
+
+Describe the expected behavior and the contract or documentation that supports it.
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### Minimal reproduction
-**Reproduction steps**
-Steps to reproduce the bug.
-<!-- Usually this means a small and self-contained piece of code that uses Catch and specifying compiler flags if relevant. -->
+Provide a small C++20 test, the command used to build and run it, and the test-runner arguments. For a property failure, include the root seed, replay seed, trial number, and minimized counterexample when available. For a snapshot failure, describe the snapshot mode and file location without pasting private content.
+### Environment
-**Platform information:**
-<!-- Fill in any extra information that might be important for your issue. -->
- - OS: **Windows NT**
- - Compiler+version: **GCC v2.9.5**
- - Catch version: **v1.2.3**
+- Catch3 commit or release:
+- OS and architecture:
+- Compiler and version:
+- Build system and version (Bazel, CMake, Meson, Xmake, or Premake):
+- Relevant flags or configuration:
+### Additional context
-**Additional context**
-Add any other context about the problem here.
+Attach sanitized logs or screenshots if they help. State whether the problem reproduces on a clean checkout.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index be9b9eea..488b5562 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,14 +1,28 @@
---
name: Feature request
-about: Create an issue that requests a feature or other improvement
-title: ''
-labels: ''
-assignees: ''
-
+about: Propose an improvement to Progmasoft Catch3
+title: "[Feature] "
---
-**Description**
-Describe the feature/change you request and why do you want it.
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-1.1 -->
+
+Read [Catch3's scope and compatibility policy](https://github.com/Progmasoft/catch3/blob/devel/docs/why-catch3.md) before proposing a change. Catch3 additions and changes to the Catch2-compatible engine have different ownership and compatibility constraints.
+
+### Problem and use case
+
+What testing task is difficult today? Include a concrete example from a real test suite.
+
+### Proposed behavior
+
+Describe the user-facing API or runner behavior, with a short C++20 example if useful. Explain how failures should be reported and reproduced.
+
+### Ownership and compatibility
+
+- Does this belong in `Progmasoft::Catch3`, the compatibility engine, build tooling, or documentation?
+- Would it change existing Catch2 headers, macros, command-line behavior, or reporters?
+- Would it need compiled code, a new dependency, or a new minimum compiler version?
+
+### Alternatives and validation
-**Additional context**
-Add any other context or screenshots about the feature request here.
+What workaround exists today? What focused test would show that the proposed behavior works?