From ed102dc730fe4fde3b0ac98d9d1f19f4fa338846 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Thu, 23 Jan 2025 13:35:30 +0200 Subject: [PATCH] feat: add GitHub issue templates for bug reports and feature requests --- .github/ISSUE_TEMPLATE/bug-report.yml | 56 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 12 +++++ .github/ISSUE_TEMPLATE/feature-request.yml | 31 ++++++++++++ 3 files changed, 99 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..cfe06274 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,56 @@ +name: "\U0001FAB2 Bug Report" +description: Submit a bug report to help us improve PR-Agent +labels: [ "bug" ] +body: + - type: textarea + id: system-info + attributes: + label: System Info + description: Please share your system info with us. + render: shell + placeholder: platform, python version, model used, etc... + validations: + required: true + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Information + description: 'The problem arises when using:' + options: + - label: "The official example scripts" + - label: "My own modified scripts" + + - type: checkboxes + id: information-tasks + attributes: + label: Tasks + description: "The tasks I am working on are:" + options: + - label: "An officially supported task in the `examples` folder (such as GLUE/SQuAD, ...)" + - label: "My own task or dataset (give details below)" + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction (minimal, reproducible, runnable) + description: | + Please provide a code sample that reproduces the problem you ran into. It can be a GitHub link or just a code snippet. + If you have code snippets, error messages, stack traces please provide them here as well. + Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. + Providing a **minimal**, **reproducible** reproduction using a **publicly available model** significantly increase the chances of a fix in a timely manner. + + placeholder: | + Providing a minimal, reproducible reproduction using a publicly available model significantly increase the chances of a fix in a timely manner. + + + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: Expected behavior + description: "A clear and concise description of what you would expect to happen." diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..493a1ecb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: true +version: 0.1 +contact_links: + - name: Discord community + url: https://discord.gg/kG35uSHDBc + about: Join our discord community + - name: Qodo Merge documentation + url: https://qodo-merge-docs.qodo.ai/ + about: Access comprehensive guides + - name: Qodo site + url: https://www.qodo.ai/ + about: Visit our main website diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..9ff76dad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,31 @@ +name: "\U0001F4A1 Feature request" +description: Submit a proposal/request for a new PR-Agent feature +labels: [ "feature" ] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. Please provide a link to the paper and code in case they exist. + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too. + + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? \ No newline at end of file