From 196914322655c8b477a74ebe455571a6b6153a76 Mon Sep 17 00:00:00 2001 From: "Andy K. Massimino" Date: Mon, 10 Aug 2020 23:19:03 -0400 Subject: [PATCH] Minor update --- .../bug_report.md} | 8 +++++++- .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++++++ CONTRIBUTING.md | 3 ++- README.md | 5 ++--- 4 files changed, 28 insertions(+), 5 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (92%) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 92% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index b9b2479..243790d 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,9 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug +--- + ### Explain the issue Most issues are related to bugs or problems. In these cases, you should @@ -12,6 +18,7 @@ well as: If your issue is instead a feature request or anything else, please consider if minimal examples and vimrc files might still be relevant. + ### Minimal working example Please provide a minimal working example, e.g., @@ -46,4 +53,3 @@ syntax enable " match-up options go here ``` - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2356405 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: enhancement +--- + +**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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eed1d5a..f15deea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Issue descriptions -Please see the [issue template](ISSUE_TEMPLATE.md) for how to write a good +Please see the [issue template](.github/ISSUE_TEMPLATE/bug_report.md) +for how to write a good issue description. In short, it should contain the following: 1. Describe the issue in detail, include steps to reproduce the issue diff --git a/README.md b/README.md index 05ffbb4..49681e0 100644 --- a/README.md +++ b/README.md @@ -763,9 +763,9 @@ heavily influenced by vimtex. :beers: ### Reporting problems -This is a new plugin and there are likely to be some bugs. Thorough issue reports are encouraged. Please read the [issue -template](ISSUE_TEMPLATE.md) first. Be as precise and detailed as +template](.github/ISSUE_TEMPLATE/bug_report.md) first. Be as precise and +detailed as possible when submitting issues. Feature requests are also welcome. @@ -775,6 +775,5 @@ Feature requests are also welcome. Please read the [contribution guidelines](CONTRIBUTING.md) before contributing. -A major goal of this project is to keep a modern and modular code base. Contributions are welcome!