From 7b15838877e820b5edd4a4bfb31f242bc1d7f5e4 Mon Sep 17 00:00:00 2001 From: olszomal Date: Fri, 9 Jan 2026 14:38:52 +0100 Subject: [PATCH] Add GitHub issue and PR templates --- .github/ISSUE_TEMPLATE.md | 8 ++ .github/ISSUE_TEMPLATE/10_crash_report.md | 74 +++++++++++++++++++ .github/ISSUE_TEMPLATE/20_documentation.md | 26 +++++++ .github/ISSUE_TEMPLATE/30_feature_request.md | 30 ++++++++ .github/ISSUE_TEMPLATE/40_questions.md | 17 +++++ .github/ISSUE_TEMPLATE/50_bug_report.md | 77 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 65 +++++++++++++++++ 7 files changed, 297 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/10_crash_report.md create mode 100644 .github/ISSUE_TEMPLATE/20_documentation.md create mode 100644 .github/ISSUE_TEMPLATE/30_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/40_questions.md create mode 100644 .github/ISSUE_TEMPLATE/50_bug_report.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 0000000..996dbf0 --- /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/10_crash_report.md b/.github/ISSUE_TEMPLATE/10_crash_report.md new file mode 100644 index 0000000..741e651 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10_crash_report.md @@ -0,0 +1,74 @@ +--- +name: Crash report +about: Report a segmentation fault or other crash +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: + - [ ] upstream master + - [ ] upstream release (tag): + - [ ] distribution package (name and version): +- `openssl version -a` +- `osslsigncode --version` + +### Configuration / Settings + + +### Anything else + diff --git a/.github/ISSUE_TEMPLATE/20_documentation.md b/.github/ISSUE_TEMPLATE/20_documentation.md new file mode 100644 index 0000000..8b26364 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20_documentation.md @@ -0,0 +1,26 @@ +--- +name: Documentation +about: Report an error in (or missing) documentation +labels: documentation +--- + + + +### Documentation Location + + +### Issue Description + + +### Suggested Improvement (optional) + diff --git a/.github/ISSUE_TEMPLATE/30_feature_request.md b/.github/ISSUE_TEMPLATE/30_feature_request.md new file mode 100644 index 0000000..e18e2ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30_feature_request.md @@ -0,0 +1,30 @@ +--- +name: Feature request +about: Suggest a new feature or improvement +labels: feature +--- + + + +### Use Case / Motivation + + +### Proposed Change + + +### Additional Notes (optional) + diff --git a/.github/ISSUE_TEMPLATE/40_questions.md b/.github/ISSUE_TEMPLATE/40_questions.md new file mode 100644 index 0000000..391e0f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/40_questions.md @@ -0,0 +1,17 @@ +--- +name: Questions / Support +about: Please use Q&A in Discussions instead +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 [Q&A category in Discussions]() + +Bug reports and crashes should be reported using the appropriate issue templates. diff --git a/.github/ISSUE_TEMPLATE/50_bug_report.md b/.github/ISSUE_TEMPLATE/50_bug_report.md new file mode 100644 index 0000000..73286f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/50_bug_report.md @@ -0,0 +1,77 @@ +--- +name: Other 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: + - [ ] upstream master + - [ ] upstream release (tag): + - [ ] distribution package (name and version): +- `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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d8cb5a3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,65 @@ + + +### 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 + + +## License Declaration + +- [ ] I hereby agree to license my contribution under the project's license.