From a790df1a473fbbba94133d939340e9e81ef940b8 Mon Sep 17 00:00:00 2001 From: Arjun K Haridas <51917087+topguns837@users.noreply.github.com> Date: Tue, 10 Oct 2023 23:20:26 +0530 Subject: [PATCH] Added Templates for P.R., Issues and bug reports (#43) * Added .github folder with templates for feature request and bug report * Added template for pull requests * Re-arranged .github template files --- .github/ISSUE_TEMPLATE/bug_report.md | 43 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 30 ++++++++++++++++ 3 files changed, 96 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 0000000..9a7ddda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,43 @@ +--- +name: Bug report +about: Report a bug +labels: bug +--- + +## Environment 🖥️ +* OS Version: + +* Python Version: + +* Do you have a dedicated GPU ? + +* NVIDIA Driver Version (if applicable): + +* CUDA Version (if applicable): + +* Are you running this project natively or using Docker ? + +* Is the issue present in the main branch or any of the development branch ? + +
+ +``` +# paste log here +``` + +
+ +## Description 📖 +* Expected behavior: +* Actual behavior: + +## Steps to reproduce 👀 + + +1. +2. +3. + +## Output 💥 + \ 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 0000000..80fb539 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Request a new feature +labels: enhancement +--- + +## Desired behavior + + +## Alternatives considered + + +## Implementation suggestion + + +## Examples of this feature in some other project (if applicable) + + +## Additional context + \ 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 0000000..ac31a7e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ +# Description 📖 + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change 📜 + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update +- [ ] This change requires testing before it can be merged into the main/development branch + +# How Has This Been Tested? 👀 + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Test Configuration** 🖥️ +* OS version: +* Hardware: +* NVIDIA Driver: +* CUDA Version: + +