From 2e4c11595b4e36c1494ef6e9ef83bca5a34e244f Mon Sep 17 00:00:00 2001 From: nikspz <83953535+nikspz@users.noreply.github.com> Date: Mon, 20 Jan 2025 18:08:37 +0700 Subject: [PATCH 1/4] fix github template main --- .github/ISSUE_TEMPLATE/bug_report.md | 43 -------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 57 +++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 43 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 83fc873a62..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - ---- -name: Bug report -about: Create a bug report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -// A clear and concise description of what the bug is. - -**Steps To Reproduce** -// A concise description of the **steps to reproduce the buggy behavior**: - -Here are the steps to reproduce the issue (see attachments in the section below): -1. Set up your configuration file with these parameters: ... -2. Start the bot using this command: ... -... - -**Screenshots** -// If applicable, add screenshots to help explain your problem. - -**Release version** -// Include your bot's version number (Can be found at the upper left corner of your CLI). - -**Attachments** -// It is important that you attach the required files for us to be able to investigate the issue. -// Please attach the chain.yml file from your gateway "conf" folder, e.g ethereum.yml - - -*WARNING: Do NOT publish any exchange API keys or your wallet's private key. Whoever has access to them may steal your assets!* - -**Optional: your discord username:** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..b15865f96b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,57 @@ +name: Bug Report +description: Create a bug report to help us improve +title: "Bug Report" +labels: bug +body: + - type: markdown + attributes: + value: | + ## **Before Submitting:** + + * Please edit the "Bug Report" to the title of the bug or issue + * Please make sure to look on our GitHub issues to avoid duplicate tickets + * You can add additional `Labels` to support this ticket (connectors, strategies, etc) + * If this is something to do with installation and how to's we would recommend to visit our [Hummingbot docs](https://hummingbot.org/docs/) and [Discord server](https://discord.gg/hummingbot) + - type: textarea + id: what-happened + attributes: + label: Describe the bug + description: A clear and concise description of the bug or issue. Please make sure to add screenshots and error message to help us investigate + placeholder: Tell us what happened? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: A concise description of the steps to reproduce the buggy behavior + value: | + 1. + 2. + 3. + validations: + required: true + - type: input + id: version + attributes: + label: Release version + description: Include your bot version number (Can be found at the upper left corner of your CLI) + validations: + required: true + - type: dropdown + id: build + attributes: + label: Type of installation + description: What type of installation did you use? + options: + - Source + - Docker + validations: + required: true + - type: textarea + id: attachment + attributes: + label: Attach required files + description: Please attach your config file and log file located on the "../gateway/logs/" folder. It would be really helpful to triage the issue. + validations: + required: false From 117192ce0367498cb3f09e1fe8ef6921d2053f1a Mon Sep 17 00:00:00 2001 From: nikspz <83953535+nikspz@users.noreply.github.com> Date: Mon, 20 Jan 2025 18:10:10 +0700 Subject: [PATCH 2/4] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 57 +++++++++++++---------- 1 file changed, 32 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 141c4261a7..13eb0bc9ed 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,28 +1,35 @@ ---- name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - ---- -name: Feature request -about: Suggest an idea for this project -title: '' +description: Suggest an idea that will improve the Hummingbot codebase +title: "Feature Request" labels: enhancement -assignees: '' - ---- - -**Feature Suggestion** -// A succinct description of **how you want to achieve the desired behavior**. -// If you have looked at the code and know exactly what code changes are needed then please _consider submitting a pull request_ instead. - -**Impact** -// A succinct description of **why you want the _desired behavior_** specified above. -The desired behavior will allow me to ... +body: + - type: markdown + attributes: + value: | + ## **Before Submitting:** -**Additional context** -Add any other context or screenshots about the feature request here. + * Please edit the "Feature Request" to the title of the feature + * Please make sure to look on our GitHub issues to avoid duplicate tickets + * You can add additional `Labels` to support this ticket (connectors, strategies, etc) + * If this is something to do with installation and how to's we would recommend to visit our [Discord server](https://discord.gg/hummingbot) and [Hummingbot docs](https://hummingbot.org/docs/) + - type: textarea + id: feature-suggestion + attributes: + label: Feature Suggestion + description: A clear and concise description of the feature request. If you have looked at the code and know exactly what code changes are needed then please consider submitting a pull request instead. + placeholder: How you want to achieve the desired behavior + validations: + required: true + - type: textarea + id: feature-impact + attributes: + label: Impact + description: A succinct description of why you want the desired behavior specified above. + placeholder: The desired behavior will allow me to.. + validations: + required: true + - type: textarea + id: feature-additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here (optional) From ef898ac9636ca4469a3f79b7a1b695c2ab8dfebe Mon Sep 17 00:00:00 2001 From: nikspz <83953535+nikspz@users.noreply.github.com> Date: Mon, 20 Jan 2025 18:10:46 +0700 Subject: [PATCH 3/4] Rename feature_request.md to feature_request.yml --- .../ISSUE_TEMPLATE/{feature_request.md => feature_request.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{feature_request.md => feature_request.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/feature_request.yml From 97cd6f4bd2d11623bda486b004a27cd6f588f2c2 Mon Sep 17 00:00:00 2001 From: Gordon Julian Koehn Date: Sun, 26 Jan 2025 17:52:15 +0100 Subject: [PATCH 4/4] Update README.md The link to the docker compose example to deploy hummingbot and gateway is outdated. I replaced it with the link to the docs. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b3352c178..8960f2adee 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Gateway may be used alongside the main [Hummingbot client](https://github.com/hu ## Installation via Docker -If you are installing Gateway alongside Hummingbot, check out the [Deploy Examples](https://github.com/hummingbot/deploy-examples) repository that helps you deploy various types of Hummingbot and Gateway configurations. For most new users, we recommend following the [Hummingbot Gateway Compose](https://github.com/hummingbot/deploy-examples/tree/main/hummingbot_gateway_compose) deployment. +If you are installing Gateway alongside Hummingbot, check out the [Deploy Examples](https://github.com/hummingbot/deploy-examples) repository that helps you deploy various types of Hummingbot and Gateway configurations. For most new users, we recommend following the [Hummingbot Gateway Compose](https://hummingbot.org/gateway/installation/) deployment. The repo also contains [Bash Scripts](https://github.com/hummingbot/deploy-examples/tree/main/bash_scripts#gateway) that help you install the Gateway Docker image on a standalone basis.