From bc9bb91880179962146fcaa033ac971e917f5314 Mon Sep 17 00:00:00 2001 From: olszomal Date: Thu, 8 Jan 2026 12:06:59 +0100 Subject: [PATCH] Add GitHub issue and PR templates --- .github/ISSUE_TEMPLATE.md | 8 +++ .github/ISSUE_TEMPLATE/bug_report.md | 78 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/crash_report.md | 68 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/discussions.md | 17 +++++ .github/ISSUE_TEMPLATE/documentation.md | 9 +++ .github/ISSUE_TEMPLATE/feature_request.md | 9 +++ .github/PULL_REQUEST_TEMPLATE.md | 57 +++++++++++++++++ 7 files changed, 246 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/crash_report.md create mode 100644 .github/ISSUE_TEMPLATE/discussions.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..996dbf07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,8 @@ + + +If you are reporting a bug or crash, please use the appropriate issue template. + +For questions or support, use please use [Discussions](). diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..2569ee39 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,78 @@ +--- +name: Bug report +about: Report a bug +labels: bug +--- + + + +### Current Behavior + + +### Expected Behavior + + +### Steps To Reproduce & Observed Output + +1. Signing with osslsigncode + + +2. Verification with osslsigncode + + +3. Signing / verification with Windows signtool (if applicable) + + +### Environment +- Operating system and version (e.g. Ubuntu 24.04): +- Architecture (x86_64, arm64, etc.): + +### Versions + +- osslsigncode built from: + - [ ] source + - [ ] distribution package +- `openssl version -a` +- `osslsigncode --version` + +### Files + +- [ ] unsigned file +- [ ] file signed with osslsigncode +- [ ] file signed with signtool or the other tool (for comparison) +- [ ] certificate chain used for verification (PEM format) + +### Configuration / Settings + + +### Anything else + + + diff --git a/.github/ISSUE_TEMPLATE/crash_report.md b/.github/ISSUE_TEMPLATE/crash_report.md new file mode 100644 index 00000000..e7526961 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash_report.md @@ -0,0 +1,68 @@ +--- +name: Crash report +about: Report a segmentation fault +labels: crash +--- + + + +### Segmentation Fault / Crash Details +- Signal / exit code: +- Reproducibility: +- Affected command or operation: +- First observed version: +- Last known working version (if any): + +#### Backtrace + +- `(gdb) bt` + +#### Memory / Sanitizers + +- [ ] Valgrind +- [ ] ASan / UBSan +- [ ] Other tools + +#### Crash Context + + +### Environment +- Operating system and version (e.g. Ubuntu 24.04): +- Architecture (x86_64, arm64, etc.): + +### Versions + +- osslsigncode built from: + - [ ] source + - [ ] distribution package +- `openssl version -a` +- `osslsigncode --version` + +### Configuration / Settings + + +### Anything else + + + diff --git a/.github/ISSUE_TEMPLATE/discussions.md b/.github/ISSUE_TEMPLATE/discussions.md new file mode 100644 index 00000000..b75ef016 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussions.md @@ -0,0 +1,17 @@ +--- +name: Questions / Support +about: Usage questions, configuration help, and general support +labels: question +--- + +## Questions and Support + +Please do **not** use GitHub issues for general questions or support requests. + +For: +- usage questions +- "how do I..." questions + +please use [Discussions]() + +Bug reports and crashes should be reported using the appropriate issue templates. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..15d3824a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,9 @@ +--- +name: Documentation +about: Report an error in (or missing) documentation +labels: documentation +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..167ce213 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,9 @@ +--- +name: Feature request +about: Propose a feature you would like to see added in the software +labels: feature +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..222650d7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,57 @@ + + +### Pull Request Type + + +- [ ] Bug fix +- [ ] New feature +- [ ] Code style / formatting / renaming +- [ ] Refactoring (no functional or API changes) +- [ ] Build / CI related changes +- [ ] Documentation +- [ ] Other (please describe): + +### Related Issue + +Issue number: N/A + +### Current Behavior + + +### New Behavior + + +### Scope of Changes + + +### Testing + +- [ ] Existing tests +- [ ] New tests added +- [ ] Manual testing + +### Additional Notes +