Переглянути джерело

Fix #416: Add an issue and PR template.

Jeremy Pallats/starcraft.man 10 роки тому
батько
коміт
d96e303692
3 змінених файлів з 49 додано та 4 видалено
  1. 32 0
      .github/ISSUE_TEMPLATE.md
  2. 8 0
      .github/PULL_REQUEST_TEMPLATE.md
  3. 9 4
      README.md

+ 32 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+<!--
+### Before Submitting
+
+- You checked the [faq](https://github.com/junegunn/vim-plug/wiki/faq) for common problems.
+- Check your [requirements](https://github.com/junegunn/vim-plug/wiki/requirements) are satisfied.
+- You are not going to suggest vim-plug manage itself like Vundle, see #240, #364, #367 ...
+-->
+
+Explain the problem here ...
+
+------------------------------
+
+<!-- Put the contents of `:version` below -->
+```
+
+```
+
+<!-- Check all that apply. -->
+- Type:
+    - [ ] Bug
+    - [ ] Enhancement
+    - [ ] Feature Request
+    - [ ] Question
+- OS:
+    - [ ] All/Other
+    - [ ] Linux
+    - [ ] OS X
+    - [ ] Windows
+- Vim:
+    - [ ] Terminal Vim
+    - [ ] GVim
+    - [ ] Neovim

+ 8 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+<!-- ## Before Submitting
+
+- You made sure the existing tests/travis build works.
+- You made sure any new features were tested where appropriate.
+- You checked a similar feature wasn't already turned down by searching issues & PRs.
+-->
+
+Describe the details of your PR ...

+ 9 - 4
README.md

@@ -49,6 +49,15 @@ $uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
 (New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\autoload\plug.vim"))
 ```
 
+### Getting Help
+
+- See the [requirements] page for debugging information & tested configurations.
+- See the [FAQ] for common problems and questions.
+- Create an [issue](https://github.com/junegunn/vim-plug/issues/new).
+
+[FAQ]: https://github.com/junegunn/vim-plug/wiki/faq
+[requirements]: https://github.com/junegunn/vim-plug/wiki/requirements
+
 ### Usage
 
 Add a vim-plug section to your `~/.vimrc` (or `~/.config/nvim/init.vim` for Neovim):
@@ -226,10 +235,6 @@ let g:fzf_install = 'yes | ./install'
 Plug 'junegunn/fzf', { 'do': g:fzf_install }
 ```
 
-### FAQ/Troubleshooting
-
-See [FAQ/Troubleshooting](https://github.com/junegunn/vim-plug/wiki/faq).
-
 ### Articles
 
 - [Writing my own Vim plugin manager](http://junegunn.kr/2013/09/writing-my-own-vim-plugin-manager)