From 4079dc5578e362639bb81c8ea1a50a43c2f6936f Mon Sep 17 00:00:00 2001 From: Dixing Xu Date: Thu, 21 Nov 2024 17:59:54 +0800 Subject: [PATCH] :construction_worker: Add github templates * Add issue templates * Add pr template --- .github/ISSUE_TEMPLATE/bug_report.yml | 58 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++ .github/ISSUE_TEMPLATE/technical_proposal.md | 18 ++++++ .github/pull_request_template.md | 8 +++ 4 files changed, 102 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/technical_proposal.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..372e309 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: Bug +description: Report a problem with AIDE +title: '[Bug]: ' +labels: ['bug'] +body: + - type: markdown + attributes: + value: Thank you for taking the time to fill out this bug report. Please provide as much information as possible to help us understand and address the issue effectively. + + - type: checkboxes + attributes: + label: Is there an existing issue for the same bug? + description: Please check if an issue already exists for the bug you encountered. + options: + - label: I have checked the existing issues. + required: true + + - type: textarea + id: bug-description + attributes: + label: Describe the bug and reproduction steps + description: Provide a description of the issue along with any reproduction steps. + validations: + required: true + + - type: dropdown + id: installation + attributes: + label: AIDE Installation + description: How are you running AIDE? + options: + - Commandline + - Docker + - Python Script + - Other + default: 0 + + - type: input + id: aideml-version + attributes: + label: AIDE Version + description: What version of AIDE are you using? + placeholder: ex. 0.1.4, main, etc. + + - type: dropdown + id: os + attributes: + label: Operating System + options: + - MacOS + - Linux + - WSL on Windows + + - type: textarea + id: additional-context + attributes: + label: Logs, Errors, Screenshots, and Additional Context + description: Please provide any additional information you think might help. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1767197 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature Request +about: Suggest an idea for OpenHands features +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**What problem or use case are you trying to solve?** + +**Describe the UX of the solution you'd like** + +**Do you have thoughts on the technical implementation?** + +**Describe alternatives you've considered** + +**Additional context** diff --git a/.github/ISSUE_TEMPLATE/technical_proposal.md b/.github/ISSUE_TEMPLATE/technical_proposal.md new file mode 100644 index 0000000..a0e38e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical_proposal.md @@ -0,0 +1,18 @@ +--- +name: Technical Proposal +about: Propose a new architecture or technology +title: '' +labels: 'proposal' +assignees: '' + +--- + +**Summary** + +**Motivation** + +**Technical Design** + +**Alternatives to Consider** + +**Additional context** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e2b85c3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +## Description + +* a simple description of what you're trying to accomplish +* a summary of changes in code +* which issues it fixes, if any + +## Screenshots/videos: +