Skip to content

Commit 8a4918e

Browse files
committed
chore: add bug and feature issue templates
Signed-off-by: behnazh-w <[email protected]>
1 parent f335ec0 commit 8a4918e

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior in Macaron.
4+
title: "[Bug] - [Describe Issue]"
5+
labels: bug, triage
6+
assignees: ''
7+
---
8+
9+
### Description
10+
Please provide a clear and concise description of the issue you're experiencing with Macaron. Be as detailed as possible about the problem.
11+
12+
### Steps to Reproduce
13+
Please list the steps required to reproduce the issue:
14+
15+
1. **Step 1**: [Describe the first step]
16+
2. **Step 2**: [Describe the second step]
17+
3. **Step 3**: [Describe the third step]
18+
4. [Continue adding steps if necessary]
19+
20+
### Expected Behavior
21+
What were you expecting to happen?
22+
23+
### Actual Behavior
24+
What actually happened? Please include any error messages, logs, or unexpected behavior you observed.
25+
26+
### Debug Information
27+
Please run the command again with the `--verbose` option to provide debug information. This will help us diagnose the issue more effectively. You can add this option to the command like this:
28+
29+
```shell
30+
./run_macaron.sh --verbose [other options]
31+
```
32+
33+
Attach the debug output here if possible.
34+
35+
### Environment Information
36+
To assist with troubleshooting, please provide the following information about your environment:
37+
38+
Operating System: (e.g., Ubuntu 20.04, macOS 11.2)
39+
40+
Bash Version: (Run bash --version to get the version)
41+
42+
Docker or Podman Version: (Run docker --version to get the version)
43+
44+
Macaron Version: (If available, please specify the Macaron version you're using)
45+
46+
Additional Information: (Any other relevant details, such as hardware or network environment, such as proxies)
47+
48+
### Screenshots or Logs
49+
If applicable, please provide screenshots or logs that illustrate the bug.
50+
51+
### Additional Information
52+
Any other information that might be useful to identify or fix the bug. For example:
53+
54+
Any steps that worked around the issue
55+
56+
Specific configurations or files that may be relevant

Diff for: .github/ISSUE_TEMPLATE/config.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: GitHub Discussions
7+
url: https://github.com/oracle/macaron/discussions
8+
about: Please ask and answer questions here.
9+
- name: Security Reports
10+
url: https://github.com/oracle/macaron/blob/main/SECURITY.md
11+
about: Please report security vulnerabilities following the instructions.

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for Macaron.
4+
title: "[Feature Request] - [Describe Feature]"
5+
labels: enhancement, feature
6+
assignees: ''
7+
8+
---
9+
10+
### Description
11+
Please provide a clear and concise description of the feature or enhancement you'd like to see in Macaron. Explain why it would be useful and how it could improve the tool.
12+
13+
### Proposed Feature
14+
What functionality or feature would you like to add to Macaron? Please describe it in detail.
15+
16+
### Use Case

0 commit comments

Comments
 (0)