diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..ddc0501 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,11 @@ +# Issue Checks + +Prior to submitting a new issue make sure to complete these steps: + +1. Checkout the `dev` branch and confirm the issue is present there as well. + The `dev` branch contains fixes that may not have been merged to `master` yet. +2. Post the syntax you are using (default/mediawiki/markdown) **and** your vimwiki settings from your `.vimrc` +3. Provide a detailed description of the problem including **steps to reproduce the issue**. +4. Include the output of `:VimwikiShowVersion`. + +**DELETE THIS TEMPLATE TEXT PRIOR TO SUBMITTING THE ISSUE** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..256df18 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +# Pull Request Checks + +1. **ALL** pull requests should be made against the `dev` branch! +2. Take a look at [CONTRIBUTING.MD](https://github.com/vimwiki/vimwiki/blob/dev/CONTRIBUTING.md) +3. Reference any related issues. +4. Provide a description of the proposed changes and any testing that was done. +5. Make sure to update the documentation in `doc/vimwiki.txt` if applicable. + +**DELETE THIS TEMPLATE TEXT PRIOR TO SUBMITTING YOUR PULL REQUEST** diff --git a/README.md b/README.md index 3ce36f5..1dc0417 100644 --- a/README.md +++ b/README.md @@ -174,8 +174,13 @@ Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was insta Getting help ============================================================================== -Have a question? Visit the IRC channel `#vimwiki` on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki)) -or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki). +Have a question? Visit the IRC channel `#vimwiki` on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org`) or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki). + +Helping Vimwiki +============================================================================== + +Vimwiki has a lot of users but only very few recurring developers or people helping the community. Your help is therefore appreciated. Everyone can help! See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on how you can help. + ---- diff --git a/doc/vimwiki.txt b/doc/vimwiki.txt index 4f935e5..3f31312 100644 --- a/doc/vimwiki.txt +++ b/doc/vimwiki.txt @@ -1423,7 +1423,7 @@ Hit |zr| one more time : Note: If you use the default Vimwiki syntax, folding on list items will work properly only if all of them are indented using the current 'shiftwidth'. -For MediaWiki syntax, * or # should be in the first column. +For Markdown and MediaWiki syntax, * or # should be in the first column. To turn folding on/off check |g:vimwiki_folding|. @@ -2280,8 +2280,8 @@ local mappings |vimwiki_glstar|, |vimwiki_gl#| |vimwiki_gl-|, |vimwiki_gl-|, |vimwiki_gl1|, |vimwiki_gla|, |vimwiki_glA|, |vimwiki_gli|, |vimwiki_glI| and |vimwiki_i__|. -Note: if you use MediaWiki syntax, you probably would like to set this option -to 0, because every indented line is considered verbatim text. +Note: if you use Markdown or MediaWiki syntax, you probably would like to set +this option to 0, because every indented line is considered verbatim text. *vimwiki-option-auto_tags*