Skip to content

Commit 375f279

Browse files
committed
CONTRIBUTING
1 parent 77574c3 commit 375f279

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ Discussions about patches happen on the vim-dev maillist.
55
If you create a pull request on GitHub it will be
66
forwarded to the vim-dev maillist. You can also send your patch there
77
directly. In that case an attachment with a unified diff format is preferred.
8-
Information about the maillist can be found [on the Vim website].
9-
10-
[on the Vim website]: http://www.vim.org/maillist.php#vim-dev
8+
Information about the maillist can be found [on the Vim website][0]
119

1210
A pull request has the advantage that it will trigger the Continuous
1311
Integration tests, you will be warned of problems (you can ignore the coverage
@@ -22,7 +20,6 @@ Contributions will be distributed with Vim under the Vim license. Providing a
2220
change to be included implies that you agree with this and your contribution
2321
does not cause us trouble with trademarks or patents. There is no CLA to sign.
2422

25-
2623
# Reporting issues
2724

2825
We use GitHub issues, but that is not a requirement. Writing to the Vim
@@ -43,10 +40,7 @@ is fixed.
4340
Feel free to report even the smallest problem, also typos in the documentation.
4441

4542
You can find known issues in the todo file: ":help todo".
46-
Or open [the todo file] on GitHub to see the latest version.
47-
48-
[the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt
49-
43+
Or open [the todo file][todo list] on GitHub to see the latest version.
5044

5145
# Syntax, indent and other runtime files
5246

@@ -77,8 +71,28 @@ can be translated:
7771
The help files can be translated and made available separately.
7872
See https://www.vim.org/translations.php for examples.
7973

74+
# How do I contribute to the project?
75+
76+
Please have a look at the following [discussion][6] which should give you some
77+
ideas. Please also check the [develop.txt][7] helpfile for the recommended
78+
style. Often it's also beneficial to check the surrounding code for the style
79+
being used.
80+
81+
# I have a question
82+
83+
If you have some question on the style guide, please contact the [vim-dev][0]
84+
mailing list. For other questions please use the [Vi Stack Exchange][8] website, the
85+
[vim-use][9] mailing list or make use of the [discussion][10] feature here at github.
86+
87+
[todo list]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt
88+
[0]: http://www.vim.org/maillist.php#vim-dev
8089
[1]: https://github.com/vim/vim/blob/master/src/po/README.txt
8190
[2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt
8291
[3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt
8392
[4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1
8493
[5]: https://github.com/vim/vim/blob/master/nsis/lang/english.nsi
94+
[6]: https://github.com/vim/vim/discussions/13087
95+
[7]: https://github.com/vim/vim/blob/master/runtime/doc/develop.txt
96+
[8]: https://vi.stackexchange.com
97+
[9]: http://www.vim.org/maillist.php#vim-use
98+
[10]: https://github.com/vim/vim/discussions

0 commit comments

Comments
 (0)