diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 708be86..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Reporting an issue with the existing forgit code -title: "[BUG] - " -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Shell: [bash, fish, zsh] - - Shell Version: - - Any other terminal config? [tmux, etc] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 36a3044..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE REQUEST] " -labels: feature request -assignees: wfxr - ---- - -**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. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..8adeb47 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,23 @@ + + + + +## Check list + +- [ ] I have read through the [README](https://github.com/wfxr/forgit/blob/master/README.md) +- [ ] I have the latest version of forgit +- [ ] I have searched through the existing issues + +## Environment info + +- OS + - [ ] Linux + - [ ] Mac OS X + - [ ] Windows + - [ ] Others: +- Shell + - [ ] bash + - [ ] zsh + - [ ] fish + +## Problem / Steps to reproduce diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 597cad0..6139a61 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,33 @@ -# Description + -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context, such as the description of the bug you're trying to fix. + -Fixes # (issue) +## Check list + +- [ ] I have performed a self-review of my code +- [ ] I have commented my code in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation + +## Description + + ## Type of change -Please delete options that are not relevant. +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor +- [ ] Breaking change +- [ ] Documentation change -- [ ] 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 +## Test environment -## Shells this fix should effect: -- [ ] bash -- [ ] zsh -- [ ] fish - -## Shells this fix has been tested in: -- [ ] bash -- [ ] zsh -- [ ] fish - -**Test Configuration**: -* OS: - -# 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 - -@cjappl @wfxr +- Shell + - [ ] bash + - [ ] zsh + - [ ] fish +- OS + - [ ] Linux + - [ ] Mac OS X + - [ ] Windows + - [ ] Others: