Skip to content

Commit e61fa40

Browse files
committed
Add Issue Templates
1 parent 1c24552 commit e61fa40

File tree

4 files changed

+141
-0
lines changed

4 files changed

+141
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug Report
2+
description: Report a bug or documentation issue with RTI Connector for Rust
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the sections below to help us understand and reproduce the issue.
10+
11+
- type: input
12+
id: connector-version
13+
attributes:
14+
label: Connector Version
15+
description: Which version of RTI Connector for Rust are you using?
16+
placeholder: e.g., 1.5.0, or commit hash
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected-behavior
22+
attributes:
23+
label: Expected Behavior
24+
description: What did you expect to happen?
25+
placeholder: Describe the expected behavior...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: actual-behavior
31+
attributes:
32+
label: Actual Behavior
33+
description: What actually happened?
34+
placeholder: Describe what actually happened...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: reproducer
40+
attributes:
41+
label: Steps to Reproduce
42+
description: Please provide detailed steps to reproduce the issue, including minimal code examples if possible
43+
placeholder: |
44+
1. Create a Connector with...
45+
2. Call method...
46+
3. Observe error...
47+
48+
```rust
49+
// Minimal code example
50+
```
51+
52+
- type: textarea
53+
id: error-output
54+
attributes:
55+
label: Error Output
56+
description: If applicable, paste any error messages, stack traces, or relevant log output
57+
render: shell
58+
59+
- type: textarea
60+
id: additional-context
61+
attributes:
62+
label: Additional Context
63+
description: Add any other context about the issue here (e.g., XML configuration, build.rs output, environment variables, platform details, etc.)
64+
placeholder: Any additional information that might help...

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: View API Documentation
4+
url: https://docs.rs/rtiddsconnector/latest/rtiddsconnector/
5+
about: View the latest API documentation on docs.rs
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Feature Request / Improvement
2+
description: Suggest an improvement or new feature for RTI Connector for Rust
3+
title: "[Improvement]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting an improvement! Your feedback helps shape the future of RTI Connector for Rust.
10+
11+
- type: textarea
12+
id: use-case
13+
attributes:
14+
label: Use Case
15+
description: Describe your use case. How would this improvement benefit you and others?
16+
placeholder: This would help when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: proposed-solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe your ideal solution or enhancement
25+
placeholder: |
26+
I'd like to see...
27+
28+
Example API:
29+
```rust
30+
// Example of how the feature might work
31+
```
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: Alternatives Considered
39+
description: Have you considered any alternative solutions or workarounds?
40+
placeholder: I've tried... but it doesn't work well because...
41+
42+
- type: textarea
43+
id: additional-context
44+
attributes:
45+
label: Additional Context
46+
description: Add any other context, screenshots, links to similar features in other libraries, etc.
47+
placeholder: Any additional information that might help...
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Question
2+
description: Ask a question about RTI Connector for Rust
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Have a question? We're here to help!
10+
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: Question
15+
description: What would you like to know?
16+
placeholder: How do I... / What's the best way to... / Can RTI Connector...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: additional-context
22+
attributes:
23+
label: Additional Context
24+
description: Any additional context, code samples, configuration, or environment info that might be helpful
25+
placeholder: Any additional information that might help...

0 commit comments

Comments
 (0)