Skip to content

Commit 6b61df5

Browse files
yang-xiaodongyang-xiaodong
committed
Update github issue templates
1 parent 07c77b0 commit 6b61df5

File tree

4 files changed

+261
-15
lines changed

4 files changed

+261
-15
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: 🐞 Bug Report
2+
description: Report a reproducible issue or unexpected behavior in CAP
3+
title: "[Bug] "
4+
labels: [bug]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for reporting a CAP issue!
11+
12+
Before submitting:
13+
- Make sure you've read the documentation at [https://cap.dotnetcore.xyz](https://cap.dotnetcore.xyz).
14+
- It's **recommended** to submit a PR directly for typos or trivial fixes.
15+
- If this is a **feature request**, please use the *Feature Request* template instead.
16+
17+
- type: input
18+
id: summary
19+
attributes:
20+
label: Summary
21+
description: A short, clear summary of the bug.
22+
placeholder: e.g. CAP fails to publish message after transaction commit
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: reproduce_steps
28+
attributes:
29+
label: Steps to Reproduce
30+
description: Describe how to reproduce the issue step by step.
31+
placeholder: |
32+
1. Configure CAP with MySQL and RabbitMQ
33+
2. Publish message inside a transaction
34+
3. Commit transaction
35+
4. Observe error or missing message
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: expected_behavior
41+
attributes:
42+
label: Expected Behavior
43+
description: What should have happened?
44+
placeholder: The message should be published and consumed successfully.
45+
46+
- type: textarea
47+
id: actual_behavior
48+
attributes:
49+
label: Actual Behavior
50+
description: What actually happened?
51+
placeholder: Message not sent / consumer not triggered / error occurred
52+
53+
- type: textarea
54+
id: logs
55+
attributes:
56+
label: Log Output
57+
description: Paste the relevant CAP logs or exception stack traces here.
58+
render: shell
59+
placeholder: |
60+
[Error] DotNetCore.CAP.Internal.SubscriberExecutor: Exception occurred while processing message
61+
System.NullReferenceException: Object reference not set to an instance of an object
62+
at DotNetCore.CAP...
63+
64+
- type: textarea
65+
id: config
66+
attributes:
67+
label: CAP Configuration
68+
description: Paste your CAP configuration or initialization code.
69+
render: yaml
70+
placeholder: |
71+
{
72+
"UseDashboard": true,
73+
"UseMySql": "Server=localhost;Database=capdb;Uid=root;Pwd=123456;",
74+
"UseRabbitMQ": "HostName=localhost"
75+
}
76+
77+
- type: dropdown
78+
id: transport
79+
attributes:
80+
label: Transport Used
81+
description: Which message broker are you using?
82+
options:
83+
- RabbitMQ
84+
- Kafka
85+
- Pulsar
86+
- Azure Service Bus
87+
- InMemory
88+
- Other
89+
90+
- type: dropdown
91+
id: storage
92+
attributes:
93+
label: Storage Provider
94+
description: Which storage provider are you using?
95+
options:
96+
- MySQL
97+
- PostgreSQL
98+
- SQL Server
99+
- MongoDB
100+
- InMemory
101+
- Other
102+
103+
- type: input
104+
id: environment
105+
attributes:
106+
label: Environment
107+
description: OS, .NET version, and CAP version.
108+
placeholder: e.g. Windows 11 / .NET 8.0 / CAP 7.2.1
109+
110+
- type: textarea
111+
id: additional
112+
attributes:
113+
label: Additional Context
114+
description: Add any other information, configuration, or screenshots that may help.
115+
placeholder: e.g. This issue only occurs under heavy load or after multiple retries.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or improvement for CAP
3+
title: "[Feature] "
4+
labels: [enhancement]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for contributing ideas to CAP!
11+
12+
Before submitting:
13+
- Please make sure your idea isn’t already discussed in [Issues](https://github.com/dotnetcore/CAP/issues) or [Discussions](https://github.com/dotnetcore/CAP/discussions).
14+
- For minor code changes (typos, docs, small improvements), submitting a PR directly is recommended.
15+
- Be specific — describe the **problem**, not just the solution.
16+
17+
- type: input
18+
id: summary
19+
attributes:
20+
label: Summary
21+
description: A short, clear summary of your proposed feature.
22+
placeholder: e.g. Add native support for Azure Event Hubs
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: motivation
28+
attributes:
29+
label: Motivation / Problem
30+
description: Explain why this feature is needed. What problem does it solve or what limitation does it remove?
31+
placeholder: |
32+
CAP currently doesn't support Azure Event Hubs as a transport layer.
33+
This feature would allow easier integration with Azure cloud environments.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: proposed_solution
39+
attributes:
40+
label: Proposed Solution
41+
description: Describe how you think the feature should work or be implemented.
42+
placeholder: |
43+
Add a new `UseEventHubs()` extension similar to `UseRabbitMQ()` and `UseKafka()`.
44+
It should handle publish and consume operations via Azure SDK.
45+
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives Considered
50+
description: Have you considered any workarounds or alternative approaches?
51+
placeholder: |
52+
We can currently bridge Event Hubs via Kafka protocol, but it adds complexity.
53+
54+
- type: textarea
55+
id: impact
56+
attributes:
57+
label: Expected Impact
58+
description: Describe how this feature would improve CAP or its usability.
59+
placeholder: |
60+
This would expand CAP’s support for Azure ecosystems and help enterprise users.
61+
62+
- type: dropdown
63+
id: scope
64+
attributes:
65+
label: Feature Scope
66+
description: What area of CAP does this feature affect most?
67+
options:
68+
- Core
69+
- Transport (e.g., RabbitMQ, Kafka, Pulsar)
70+
- Storage (e.g., MySQL, PostgreSQL, MongoDB)
71+
- Dashboard / UI
72+
- Documentation
73+
- Other
74+
75+
- type: textarea
76+
id: additional
77+
attributes:
78+
label: Additional Context
79+
description: Add any other relevant details, links, or references.
80+
placeholder: e.g. Related issue numbers, design documents, or PR references.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: ❓ Question or Help
2+
description: Ask a question or request usage help about CAP
3+
title: "[Question] "
4+
labels: [question]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Need help or have a question?
11+
12+
Before submitting, please:
13+
- Read the documentation: [https://cap.dotnetcore.xyz](https://cap.dotnetcore.xyz)
14+
- Check existing [Discussions](https://github.com/dotnetcore/CAP/discussions) and [Issues](https://github.com/dotnetcore/CAP/issues)
15+
- Use this form for **usage questions**, **configuration issues**, or **how-to** discussions.
16+
- If you think this is a **bug**, please use the *Bug Report* template instead.
17+
18+
- type: input
19+
id: topic
20+
attributes:
21+
label: Question Summary
22+
description: A short summary of what you need help with.
23+
placeholder: e.g. How to retry messages when using RabbitMQ?
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: context
29+
attributes:
30+
label: Context
31+
description: Explain your question, what you have tried, and what you expected.
32+
placeholder: |
33+
I'm using CAP with MySQL and RabbitMQ.
34+
The message was not retried after exception.
35+
Is there a configuration to enable retry?
36+
37+
- type: textarea
38+
id: code
39+
attributes:
40+
label: Relevant Code or Configuration
41+
description: Provide related code snippets, config, or setup details.
42+
render: csharp
43+
placeholder: |
44+
builder.Services.AddCap(x =>
45+
{
46+
x.UseRabbitMQ("localhost");
47+
x.UseMySql("Server=127.0.0.1;Database=capdb;Uid=root;Pwd=123456;");
48+
});
49+
50+
- type: dropdown
51+
id: environment
52+
attributes:
53+
label: Environment
54+
description: What environment are you using CAP in?
55+
options:
56+
- .NET 8.0
57+
- .NET 7.0
58+
- .NET 6.0
59+
- Other
60+
61+
- type: textarea
62+
id: additional
63+
attributes:
64+
label: Additional Information
65+
description: Add any other context or reference links that may help answer your question.
66+
placeholder: e.g. Related GitHub issue, article, or code sample link.

‎.github/issue_template.md‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)