From 51af4c3ffe47bc0c33d012db5cb59647b324ad12 Mon Sep 17 00:00:00 2001 From: LuanRT Date: Thu, 3 Mar 2022 03:29:08 -0300 Subject: [PATCH] chore: add issue & pull request template --- .github/ISSUE_TEMPLATE/FEATURE.md | 19 +++++++++ .github/ISSUE_TEMPLATE/ISSUE.md | 39 +++++++++++++++++++ .github/ISSUE_TEMPLATE/QUESTION.md | 15 +++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .../pull_request_template.md | 27 +++++++++++++ 5 files changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/FEATURE.md create mode 100644 .github/ISSUE_TEMPLATE/ISSUE.md create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/FEATURE.md b/.github/ISSUE_TEMPLATE/FEATURE.md new file mode 100644 index 00000000..3edf48f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Use this template for requesting new features +title: "[FEATURE NAME]" +labels: enhancement +assignees: +--- + +## Expected Behavior + +Please describe the behavior you are expecting + +## Current Behavior + +What is the current behavior? + +## Sample Code + +If applicable, provide a sample code snippet that demonstrates the gist of the feature you're proposing. This can be either from a usage standpoint, or an implementation standpoint. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/ISSUE.md b/.github/ISSUE_TEMPLATE/ISSUE.md new file mode 100644 index 00000000..149cd48b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE.md @@ -0,0 +1,39 @@ +--- +name: Issue Report +about: Use this template to report a problem +title: "[VERSION] [PROBLEM SUMMARY]" +labels: bug +assignees: +--- + +## Expected Behavior + +Please describe the behavior you are expecting + +## Current Behavior + +What is the current behavior? + +## Failure Information (for bugs) + +Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template. + +### Steps to Reproduce + +Please provide detailed steps for reproducing the issue. + +1. step 1 +2. step 2 +3. you get it... + +### Failure Logs + +Please include any relevant log snippets or files here. + +## Checklist + +- [ ] I am running the latest version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed +- [ ] I'm reporting the issue to the correct repository (for multi-repository projects) +- [ ] I have provided sufficient information \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 00000000..bec18f45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,15 @@ +--- +name: Question +about: Use this template to ask a question about the project +title: "[QUESTION SUMMARY]" +labels: question +assignees: +--- + +## Question + +State your question + +## Sample Code + +Please include relevant code snippets or files that provide context for your question. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..8452b6ec --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,27 @@ +# Pull Request Template + +## Description + +Please include a summary of the change and which issue is fixed. 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 + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] I have checked my code and corrected any misspellings \ No newline at end of file