Skip to content

Commit 7d85ac5

Browse files
olszomalolszomal
committed
Add GitHub issue and PR templates
1 parent feebbcd commit 7d85ac5

File tree

7 files changed

+297
-0
lines changed

7 files changed

+297
-0
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!--
2+
Please use one of the available issue templates.
3+
Bug reports without required information may be closed.
4+
-->
5+
6+
If you are reporting a bug or crash, please use the appropriate issue template.
7+
8+
For questions or support, use please use [Discussions](<https://github.com/mtrojnar/osslsigncode/discussions>).

‎.github/ISSUE_TEMPLATE/10_crash_report.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
name: Crash report
3+
about: Report a segmentation fault or other crash
4+
labels: crash
5+
---
6+
7+
<!--
8+
Thank you for your crash report.
9+
Note: Please search to see if an issue already exists for the bug you encountered.
10+
-->
11+
12+
### Segmentation Fault / Crash Details
13+
<!--
14+
Provide exact, reproducible steps.
15+
Include the complete command, exactly as executed.
16+
-->
17+
- Signal / exit code: <!-- SIGSEGV, SIGABRT -->
18+
- Reproducibility: <!-- always / sometimes / once -->
19+
- Affected command or operation: <!-- e.g. `osslsigncode sign`, `osslsigncode verify` -->
20+
- First observed version:
21+
- Last known working version (if any):
22+
23+
#### Backtrace
24+
<!--
25+
Provide a backtrace from gdb or lldb.
26+
Build with debug symbols if possible. Use `bt full` if possible.
27+
Crash reports without a backtrace may be closed without investigation.
28+
-->
29+
- `(gdb) bt`
30+
31+
#### Memory / Sanitizers
32+
<!--
33+
Attach relevant output if available.
34+
-->
35+
- [ ] Valgrind
36+
- [ ] ASan / UBSan
37+
- [ ] Other tools
38+
39+
#### Crash Context
40+
<!--
41+
Anything that may be relevant:
42+
- OpenSSL provider / engine in use
43+
- PKCS#11 modules
44+
- Custom OpenSSL configuration
45+
- Threading or concurrency
46+
-->
47+
48+
### Environment
49+
- Operating system and version (e.g. Ubuntu 24.04):
50+
- Architecture (x86_64, arm64, etc.):
51+
52+
### Versions
53+
<!--
54+
Please verify that the issue is reproducible with the current upstream master.
55+
-->
56+
- osslsigncode built from:
57+
- [ ] upstream master
58+
- [ ] upstream release (tag):
59+
- [ ] distribution package (name and version):
60+
- `openssl version -a`
61+
- `osslsigncode --version`
62+
63+
### Configuration / Settings
64+
<!--
65+
Anything that could affect signing or verification:
66+
- Custom OpenSSL configuration
67+
- Engine / provider settings
68+
- Environment variables (OPENSSL_CONF, etc.)
69+
-->
70+
71+
### Anything else
72+
<!--
73+
Links, references, related issues, workarounds or additional observations.
74+
-->

‎.github/ISSUE_TEMPLATE/20_documentation.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Documentation
3+
about: Report an error in (or missing) documentation
4+
labels: documentation
5+
---
6+
7+
<!--
8+
Thank you for taking the time to report a documentation issue.
9+
-->
10+
11+
### Documentation Location
12+
<!--
13+
Where is the problem located?
14+
Provide a link, file path, or section name.
15+
-->
16+
17+
### Issue Description
18+
<!--
19+
Describe what is wrong or missing.
20+
-->
21+
22+
### Suggested Improvement (optional)
23+
<!--
24+
If you know how it should be fixed, describe it here.
25+
Proposed wording or examples are especially helpful.
26+
-->

‎.github/ISSUE_TEMPLATE/30_feature_request.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement
4+
labels: feature
5+
---
6+
7+
<!--
8+
Thank you for your feature request.
9+
Please describe the use case and motivation as clearly as possible.
10+
-->
11+
12+
### Use Case / Motivation
13+
<!--
14+
What problem are you trying to solve?
15+
Why is this feature needed?
16+
-->
17+
18+
### Proposed Change
19+
<!--
20+
Describe the feature or improvement you are proposing.
21+
High-level description is sufficient.
22+
-->
23+
24+
### Additional Notes (optional)
25+
<!--
26+
Anything else that may help:
27+
- examples
28+
- references
29+
- related issues
30+
-->

‎.github/ISSUE_TEMPLATE/40_questions.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Questions / Support
3+
about: Please use Q&A in Discussions instead
4+
labels: question
5+
---
6+
7+
### Questions and Support
8+
9+
Please do **not** use GitHub issues for general questions or support requests.
10+
11+
For:
12+
- usage questions
13+
- "how do I..." questions
14+
15+
please use [Q&A category in Discussions](<https://github.com/mtrojnar/osslsigncode/discussions/new?category=q-a>)
16+
17+
Bug reports and crashes should be reported using the appropriate issue templates.

‎.github/ISSUE_TEMPLATE/50_bug_report.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Other bug report
3+
about: Report a bug
4+
labels: bug
5+
---
6+
7+
<!--
8+
Thank you for your bug report.
9+
Note: Please search to see if an issue already exists for the bug you encountered.
10+
-->
11+
12+
### Current Behavior
13+
<!--
14+
A concise description of what is happening.
15+
Include error messages or incorrect results.
16+
-->
17+
18+
### Expected Behavior
19+
<!--
20+
A concise description of what you expected to happen instead.
21+
-->
22+
23+
### Steps To Reproduce & Observed Output
24+
<!--
25+
Provide exact, reproducible steps together with full stdout/stderr for each.
26+
-->
27+
1. Signing with osslsigncode
28+
<!--
29+
Full `osslsigncode sign` command and complete stdout/stderr output.
30+
-->
31+
32+
2. Verification with osslsigncode
33+
<!--
34+
Full `osslsigncode verify` command and complete stdout/stderr output.
35+
-->
36+
37+
3. Signing / verification with Windows signtool (if applicable)
38+
<!--
39+
Full signtool command (`signtool verify /pa /v`) and complete stdout/stderr output.
40+
-->
41+
42+
### Environment
43+
- Operating system and version (e.g. Ubuntu 24.04):
44+
- Architecture (x86_64, arm64, etc.):
45+
46+
### Versions
47+
<!--
48+
Please verify that the issue is reproducible with the current upstream master.
49+
-->
50+
- osslsigncode built from:
51+
- [ ] upstream master
52+
- [ ] upstream release (tag):
53+
- [ ] distribution package (name and version):
54+
- `openssl version -a`
55+
- `osslsigncode --version`
56+
57+
### Files
58+
<!--
59+
Attach files if possible, or mention that you will share them privately.
60+
-->
61+
- [ ] unsigned file
62+
- [ ] file signed with osslsigncode
63+
- [ ] file signed with signtool or the other tool (for comparison)
64+
- [ ] certificate chain used for verification (PEM format)
65+
66+
### Configuration / Settings
67+
<!--
68+
Anything that could affect signing or verification:
69+
- Custom OpenSSL configuration
70+
- Engine / provider settings
71+
- Environment variables (OPENSSL_CONF, etc.)
72+
-->
73+
74+
### Anything else
75+
<!--
76+
Links, references, related issues, workarounds or additional observations.
77+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
Thank you for your pull request.
3+
Provide a concise summary of the changes in the PR title.
4+
-->
5+
6+
### Pull Request Type
7+
<!--
8+
Limit this PR to a single type. If necessary, split changes into multiple PRs.
9+
-->
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Code style / formatting / renaming
14+
- [ ] Refactoring (no functional or API changes)
15+
- [ ] Build / CI related changes
16+
- [ ] Documentation
17+
- [ ] Other (please describe):
18+
19+
### Related Issue
20+
<!--
21+
If this fixes a GitHub issue, make sure to have a line saying 'Fixes #XXXX' (without quotes) in the commit message.
22+
-->
23+
Issue number: N/A
24+
25+
### Current Behavior
26+
<!--
27+
Describe the current behavior or limitation this PR addresses.
28+
Include error messages or crash symptoms if relevant.
29+
-->
30+
31+
### New Behavior
32+
<!--
33+
Describe the new or changed behavior introduced by this PR.
34+
-->
35+
36+
### Scope of Changes
37+
<!--
38+
Briefly describe what was changed and why.
39+
Focus on relevant parts only.
40+
-->
41+
42+
### Testing
43+
<!--
44+
Describe how the changes were tested.
45+
Include commands, environments, or platforms if relevant.
46+
-->
47+
- [ ] Existing tests
48+
- [ ] New tests added
49+
- [ ] Manual testing
50+
51+
### Additional Notes
52+
<!--
53+
Any additional information relevant for reviewers:
54+
- design decisions
55+
- backward compatibility
56+
- known limitations
57+
-->
58+
59+
## License Declaration
60+
<!--
61+
All contributions to this project are licensed under the project's license.
62+
By submitting this pull request, you confirm that you have the right to submit
63+
the code and agree to license it accordingly.
64+
-->
65+
- [ ] I hereby agree to license my contribution under the project's license.

0 commit comments

Comments
 (0)