y0rune/vimwiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update Contributing.md

Browse Source 
WIth github interace, enfasis on the non regression tests
This commit is contained in:
Tinmarino 2020-07-21 09:06:44 -04:00 committed by GitHub
parent ed3f1ad215
commit 2f20c617d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -14,10 +14,15 @@ If you want to provide a pull request on GitHub, please start from the `dev` bra
Make sure to update `doc/vimwiki.txt` with the following information: Make sure to update `doc/vimwiki.txt` with the following information:
1. Update the changelog to include information on the new feature the PR introduces or the bug it 1. Update the changelog to include, at the top of it, information on the new feature
is fixing. the PR introduces or the bug it is fixing as well as the PR number and related issue number
if possible
2. Add a help section to describe any new features or options. 2. Add a help section to describe any new features or options.
3. If you are a first time contributor add your name to the list of contributors. 3. If you are a first time contributor add your name to the list of contributors.
4. Add some non regression tests on:
- The bug you fixed
- The new feature you added
- The API function you added or changed
**Testing:** Vimwiki uses [vader](https://github.com/junegunn/vader.vim) for unit tests and **Testing:** Vimwiki uses [vader](https://github.com/junegunn/vader.vim) for unit tests and
[vint](https://github.com/Kuniwak/vint) for linting. Any new PRs must add new tests and pass all [vint](https://github.com/Kuniwak/vint) for linting. Any new PRs must add new tests and pass all