From 04e740c6053da92d9e8337b53c50abfa4bfe9e1a Mon Sep 17 00:00:00 2001 From: rdipardo Date: Thu, 18 Jun 2020 14:34:27 -0400 Subject: [PATCH] Provide issue and PR templates --- .github/ISSUE_TEMPLATE.md | 9 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ .github/{ => img}/nvim_043_scheme.gif | Bin README.md | 10 ++++++---- 4 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md rename .github/{ => img}/nvim_043_scheme.gif (100%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..47158fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ +Please provide the following with your description of the issue + +- [ ] Platform information (e.g. Ubuntu Linux 16.04): +- [ ] Python version: +- [ ] Output of `pip list | grep requests`: +- [ ] Output of `pip list | grep pynvim` (if applicable): +- [ ] Output of `gvim --version` (if applicable): +- [ ] Output of `vim --version` (if applicable): +- [ ] Output of `nvim --version` (if applicable): diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..aaaa2fe --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +Please provide the following when submitting your PR + +#### Description +*choose one* + +- [ ] This PR addresses the following issue(s): + - https://github.com/rdipardo/vim-cpywrite/issues/<#issue-number> + +- [ ] This PR makes these improvements: + - ... + +#### Tests +*Targeting the [vader.vim framework](https://github.com/junegunn/vader.vim/blob/master/doc/vader.txt) is strongly encouraged* + +- [ ] This PR has passed these tests: + - https:// *and/or* https:// diff --git a/.github/nvim_043_scheme.gif b/.github/img/nvim_043_scheme.gif similarity index 100% rename from .github/nvim_043_scheme.gif rename to .github/img/nvim_043_scheme.gif diff --git a/README.md b/README.md index 39a6ece..3911af0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Generate copyright headers for any open source license -nvim-043-linux-demo +nvim-043-linux-demo ## Description @@ -17,9 +17,9 @@ This plugin learns your name and email by invoking `git`. If that fails, the cop ## Highlights -- Python bindings compatible with python 2.7 or 3.4+, depending on your platform and (neo)vim version, of course +- Python bindings compatible with python 2.7.x or 3.4+, depending on your platform and (neo)vim version, of course - Choose from 380 licenses (press `` after the `:CPYwrite` command for suggestions) -- No dependencies on other plugins. That said, neovim users will be grateful to have the [completeopt](https://neovim.io/doc/user/options.html#'completeopt') feature when tabbing through all the available licenses! +- No dependency on other plugins. That said, neovim users will be grateful to have the [completeopt](https://neovim.io/doc/user/options.html#'completeopt') feature when tabbing through all the available licenses! ## Quick Reference @@ -100,6 +100,7 @@ call vundle#end() ## Projects like this one * [vim-licenses][vim-lic-2.0], formerly [licenses][vim-lic-1.0] +* [vim-header][vim-hdr] * [license-to-vim][lic2vim] * [license loader][licl] @@ -119,9 +120,10 @@ Consider opening a PR with an updated [installation guide][#installation] if any ## License -MIT +Distributed under the terms of the MIT license +[vim-hdr]: https://github.com/alpertuna/vim-header [vim-lic-2.0]: https://github.com/antoyo/vim-licenses [vim-lic-1.0]: https://github.com/vim-scripts/Licenses [lic2vim]: https://www.vim.org/scripts/script.php?script_id=5349