Skip to content

Commit 45d37fe

Browse files
NaweedAghmadNaweedAghmad
committed
ADD: Issue templates for archived repository
- Bug report template with archived repo warning - Security vulnerability template (high priority) - Documentation fix template - Issue config with contact links - Clarifies only security/critical/docs issues accepted - Guides contributors with structured forms Improves issue quality and sets expectations for archived mode Signed-off-by: naweedkhan <naweed.khan@ibm.com>
1 parent 43280e9 commit 45d37fe

File tree

4 files changed

+222
-0
lines changed

4 files changed

+222
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: 🐛 Bug Report
2+
description: Report a critical bug in LNN
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## ⚠️ Repository Status
10+
11+
**This repository is archived and in maintenance mode.**
12+
13+
We are only accepting:
14+
- 🔒 Security fixes
15+
- 🐛 Critical bug fixes
16+
- 📝 Documentation corrections
17+
18+
Other feature requests and enhancements will not be reviewed.
19+
20+
---
21+
22+
- type: checkboxes
23+
id: issue-type
24+
attributes:
25+
label: Issue Type
26+
description: Please confirm this is one of the accepted types
27+
options:
28+
- label: This is a security vulnerability
29+
- label: This is a critical bug that prevents basic functionality
30+
- label: This is a documentation error
31+
32+
- type: textarea
33+
id: description
34+
attributes:
35+
label: Bug Description
36+
description: A clear and concise description of the bug
37+
placeholder: What happened?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: reproduction
43+
attributes:
44+
label: Steps to Reproduce
45+
description: Steps to reproduce the behavior
46+
placeholder: |
47+
1. Import lnn
48+
2. Run example code
49+
3. See error
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: expected
55+
attributes:
56+
label: Expected Behavior
57+
description: What you expected to happen
58+
placeholder: It should...
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: environment
64+
attributes:
65+
label: Environment
66+
description: Your environment details
67+
value: |
68+
- Python version:
69+
- LNN version:
70+
- Operating System:
71+
- torch version:
72+
- numpy version:
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: additional
78+
attributes:
79+
label: Additional Context
80+
description: Add any other context about the problem
81+
placeholder: Stack traces, screenshots, etc.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 General Questions
4+
url: https://github.com/IBM/LNN/discussions
5+
about: For general questions, please use GitHub Discussions
6+
- name: 📚 Documentation
7+
url: https://ibm.github.io/LNN/introduction.html
8+
about: Read the full documentation
9+
- name: ⚠️ Repository Archived
10+
url: https://github.com/IBM/LNN
11+
about: This repository is archived. Only security/critical bugs are accepted.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: 📝 Documentation Fix
2+
description: Report a documentation error or typo
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## 📝 Documentation Fix
10+
11+
**This repository is archived and in maintenance mode.**
12+
13+
We accept documentation corrections and clarifications.
14+
15+
---
16+
17+
- type: textarea
18+
id: location
19+
attributes:
20+
label: Documentation Location
21+
description: Where is the documentation error?
22+
placeholder: |
23+
File: README.md
24+
Line: 42
25+
Section: Installation
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: current
31+
attributes:
32+
label: Current Documentation
33+
description: What does the documentation currently say?
34+
placeholder: Paste the incorrect text
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: correct
40+
attributes:
41+
label: Suggested Correction
42+
description: What should it say instead?
43+
placeholder: Paste the corrected text
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: why
49+
attributes:
50+
label: Why This Change
51+
description: Explain why this is incorrect
52+
placeholder: This is wrong because...
53+
validations:
54+
required: true

‎.github/ISSUE_TEMPLATE/security.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: 🔒 Security Vulnerability
2+
description: Report a security vulnerability (reviewed with priority)
3+
title: "[Security]: "
4+
labels: ["security"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## 🔒 Security Report
10+
11+
Thank you for helping keep LNN secure!
12+
13+
**This repository is archived but we actively maintain security.**
14+
15+
Security reports are reviewed with **HIGH PRIORITY**.
16+
17+
---
18+
19+
- type: textarea
20+
id: vulnerability
21+
attributes:
22+
label: Vulnerability Description
23+
description: Describe the security vulnerability
24+
placeholder: What is the security issue?
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: severity
30+
attributes:
31+
label: Severity
32+
description: How severe is this vulnerability?
33+
options:
34+
- Critical
35+
- High
36+
- Medium
37+
- Low
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: impact
43+
attributes:
44+
label: Impact
45+
description: What is the potential impact?
46+
placeholder: What could an attacker do?
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: reproduction
52+
attributes:
53+
label: Reproduction Steps
54+
description: How to reproduce the vulnerability
55+
placeholder: |
56+
1. Set up environment
57+
2. Run exploit code
58+
3. Observe vulnerability
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: affected
64+
attributes:
65+
label: Affected Versions
66+
description: Which versions are affected?
67+
placeholder: All versions / v1.0+ / etc.
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: cve
73+
attributes:
74+
label: CVE or Advisory
75+
description: Is there an existing CVE or security advisory?
76+
placeholder: CVE-2024-XXXXX or link to advisory

0 commit comments

Comments
 (0)