Skip to content

Commit

Permalink
Provide issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rdipardo committed Jun 18, 2020
1 parent df554be commit 04e740c
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 4 deletions.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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):
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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://<your/new/test/files> *and/or* https://<your/successful/CI/build>
File renamed without changes
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Generate copyright headers for any open source license

<img src=".github/nvim_043_scheme.gif" alt="nvim-043-linux-demo" width="800"/>
<img src=".github/img/nvim_043_scheme.gif" alt="nvim-043-linux-demo" width="800"/>

## Description

Expand All @@ -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 `<tab>` 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
Expand Down Expand Up @@ -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]

Expand All @@ -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
Expand Down

0 comments on commit 04e740c

Please sign in to comment.