From 764ac77e93bf2f7f470a97bb9a237a30a218f4ef Mon Sep 17 00:00:00 2001 From: Yash_1124 Date: Mon, 1 Jan 2024 23:42:45 +0530 Subject: [PATCH] ADD: Issue templates added(pull request,bug,feature request).issue #120 --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 ++++++++++++++++ 3 files changed, 86 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..28bd7a6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG] Brief Description of the Issue' +labels: bug +assignees: '' + +--- + +Found a bug? Please fill out the sections below. 👍 + + +### Describe the bug + +A clear and concise description of what the bug is. + +### Steps to Reproduce + +1. (for ex.) went to... +2. clicked on this point +3. not working + +### Expected Behavior +A brief description of what you expected to happen. + +### Actual Behavior: +what actually happened. + +### Environment +- OS: +- Model Used (e.g., GPT-4v, Gemini Pro Vision): +- Framework Version (optional): + +### Screenshots +If applicable, add screenshots to help explain your problem. + +### Additional context +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..0265dee6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[FEATURE] Short Description of the Feature' +labels: enhancement +assignees: '' + +--- + +### Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the solution you'd like +A clear and concise description of what you want to happen. + +### Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c216976b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## What does this PR do? + + + +Fixes # (issue) + +## Requirement/Documentation + + + +- If there is a requirement document, please, share it here. + +## Type of change + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Chore (refactoring code, technical debt, workflow improvements) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Tests (Unit/Integration/E2E or any other test) +- [ ] This change requires a documentation update + + +## Mandatory Tasks + +- [ ] Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected. Make sure before submmiting this PR you run tests with evaluate.py