vim/vimtex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated CONTRIBUTING.md with comment on help writing

Browse Source
This commit is contained in:
Karl Yngve Lervåg 2016-04-11 17:52:21 +02:00
parent 3f64712e1f
commit 1263f31879
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -16,7 +16,24 @@ issue description. In short, it should contain the following:
vimtex is developed mainly through the master branch, and pull requests should vimtex is developed mainly through the master branch, and pull requests should
be [fork based](https://help.github.com/articles/using-pull-requests/). be [fork based](https://help.github.com/articles/using-pull-requests/).
## Code style used with vimtex ## Documentation style
Vim help files have their own specific syntax. There is a Vim help section on
how to write them, see [`:h
help-writing`](http://vimdoc.sourceforge.net/htmldoc/helphelp.html#help-writing).
The vimtex documentation style should be relatively clear, and it should be
easy to see from the existing documentation how to write it. Still, here are
some pointers:
- Max 80 columns per line
- Use the help tag system for pointers to other parts of the Vim documentation
- Use line of `=`s to separate sections
- Use line of `-`s to separate subsections
- The section tags should be right aligned at the 79th column
- Sections should be included and linked to from the table of contents
## Code style
When submitting code for vimtex, please adhere to the following standards: When submitting code for vimtex, please adhere to the following standards: