Skip to content

Commit fed05e1

Browse files
committed
Extend contributing guidelines
Add answers to some questions posed in #43.
1 parent 9423461 commit fed05e1

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,22 @@ Changing existing word list
2323
Please never change automatically generated word lists by hand. Instead, adjust
2424
the respective script in `scripts/` directory, then re-run the script before
2525
committing your changes and sending a PR.
26+
27+
Word list style guidelines
28+
--------------------------
29+
30+
* When writing word lists, preferably use Vim's straight word list format (see
31+
`:help spell-wordlist-format` for details). So far the plugin has not been
32+
tested with other Vim-supported formats (e.g. .dic and .aff).
33+
* All auto-generated lists must start with a comment indicating which script is
34+
used to update them. There is a helper in `scripts/common.sh` to generate
35+
such comment at the first line of the file.
36+
* All manually-edited lists should start with a comment explaining the main
37+
theme/topic of the list.
38+
* Words should be split into topic-specific files. We prefer to have many tiny
39+
lists instead of few large ones.
40+
* Word lists can be split into smaller sections (separated by double newline),
41+
although all sections should still relate to the same main topic. If they
42+
don't, split them into separate files.
43+
* Words should be sorted alphabetically within a list. If your word list is
44+
divided into multiple sections, sort each section individually.

0 commit comments

Comments
 (0)