From 155aa14713e26fc2bbbf316febb0af46fa604dbd Mon Sep 17 00:00:00 2001 From: behnazh-w Date: Fri, 4 Apr 2025 15:59:27 +1000 Subject: [PATCH 1/2] chore: add bug and feature issue templates Signed-off-by: behnazh-w --- .github/ISSUE_TEMPLATE/bug_report.md | 56 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 11 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 +++++++ 3 files changed, 83 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..fdc0a0761 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,56 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior in Macaron. +title: "[Bug] - [Describe Issue]" +labels: bug, triage +assignees: '' +--- + +### Description +Please provide a clear and concise description of the issue you're experiencing with Macaron. Be as detailed as possible about the problem. + +### Steps to Reproduce +Please list the steps required to reproduce the issue: + +1. **Step 1**: [Describe the first step] +2. **Step 2**: [Describe the second step] +3. **Step 3**: [Describe the third step] +4. [Continue adding steps if necessary] + +### Expected Behavior +What were you expecting to happen? + +### Actual Behavior +What actually happened? Please include any error messages, logs, or unexpected behavior you observed. + +### Debug Information +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: + +```shell +./run_macaron.sh --verbose [other options] +``` + +Attach the debug output here if possible. + +### Environment Information +To assist with troubleshooting, please provide the following information about your environment: + +Operating System: (e.g., Ubuntu 20.04, macOS 11.2) + +Bash Version: (Run bash --version to get the version) + +Docker or Podman Version: (Run docker --version to get the version) + +Macaron Version: (If available, please specify the Macaron version you're using) + +Additional Information: (Any other relevant details, such as hardware or network environment, such as proxies) + +### Screenshots or Logs +If applicable, please provide screenshots or logs that illustrate the bug. + +### Additional Information +Any other information that might be useful to identify or fix the bug. For example: + +Any steps that worked around the issue + +Specific configurations or files that may be relevant diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..45e9bae94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,11 @@ +# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved. +# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/. + +blank_issues_enabled: false +contact_links: +- name: GitHub Discussions + url: https://github.com/oracle/macaron/discussions + about: Please ask and answer questions here. +- name: Security Reports + url: https://github.com/oracle/macaron/blob/main/SECURITY.md + about: Please report security vulnerabilities following the instructions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..424b33a62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement for Macaron. +title: "[Feature Request] - [Describe Feature]" +labels: enhancement, feature +assignees: '' + +--- + +### Description +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. + +### Proposed Feature +What functionality or feature would you like to add to Macaron? Please describe it in detail. + +### Use Case From 84896396deb408a3cebfa3f7228ed579721eefc7 Mon Sep 17 00:00:00 2001 From: behnazh-w Date: Mon, 7 Apr 2025 17:14:44 +1000 Subject: [PATCH 2/2] chore: address PR feedback Signed-off-by: behnazh-w --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fdc0a0761..91355d47a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,7 +24,7 @@ What were you expecting to happen? What actually happened? Please include any error messages, logs, or unexpected behavior you observed. ### Debug Information -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: +Please run the command again with the `--verbose` [option](https://oracle.github.io/macaron/pages/cli_usage/index.html#cmdoption-v) to provide debug information. This will help us diagnose the issue more effectively. You can add this option to the command like this: ```shell ./run_macaron.sh --verbose [other options] @@ -37,11 +37,15 @@ To assist with troubleshooting, please provide the following information about y Operating System: (e.g., Ubuntu 20.04, macOS 11.2) +CPU architecture information (e.g., x86-64 (AMD64)) + Bash Version: (Run bash --version to get the version) Docker or Podman Version: (Run docker --version to get the version) -Macaron Version: (If available, please specify the Macaron version you're using) +If you are using Macaron as a Python package, please indicate that in your environment details and specify the Python version you are using. + +Macaron version or commit hash where the issue occurs. Additional Information: (Any other relevant details, such as hardware or network environment, such as proxies)