aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-12-27 19:30:23 +0100
committerJustin M. Keyes <justinkz@gmail.com>2018-06-11 00:08:27 +0200
commitf72f638f976347e2f14fc6ae5e5293c02d5ccfc1 (patch)
tree260e270e1cdb9a60e63b52d170ce305e4150686a /CONTRIBUTING.md
parentc69ea3b4b8aa8e6f3a756a49fc43a798b77f7eff (diff)
downloadrneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.tar.gz
rneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.tar.bz2
rneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.zip
doc: job/channel, misc #7783
doc: termios defaults. ref #6992 doc: :help shell-powershell doc: provider: Python minimum version is 2.7, 3.4 doc: remove :!start special-case. #5844 doc: mention #7917 change which accepts empty Array for Dictionary parameter doc: <Cmd> pseudokey doc: lmap change #5658 doc: -s, -es
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 05a97ebf18..1b73c60773 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,8 +14,15 @@ low-risk/isolated tasks:
Developer guidelines
--------------------
-- Nvim developers should read `:help dev`.
+- Nvim contributors should read `:help dev` (especially `:help dev-api`).
- External UI developers should read `:help dev-ui`.
+- API client developers should read `:help dev-api-client`.
+- Nvim developers are _strongly encouraged_ to install `ninja` for faster builds.
+ ```
+ sudo apt-get install ninja-build
+ make distclean
+ make # Nvim build system uses ninja automatically, if available.
+ ```
Reporting problems
------------------
@@ -157,7 +164,7 @@ shows each commit's diff. To show the whole surrounding function of a change
as context, use the `-W` argument as well.
[gcc-warnings]: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
-[git-bisect]: http://git-scm.com/book/tr/v2/Git-Tools-Debugging-with-Git
+[git-bisect]: http://git-scm.com/book/en/v2/Git-Tools-Debugging-with-Git
[git-feature-branch]: https://www.atlassian.com/git/tutorials/comparing-workflows
[git-history-filtering]: https://www.atlassian.com/git/tutorials/git-log/filtering-the-commit-history
[git-history-rewriting]: http://git-scm.com/book/en/v2/Git-Tools-Rewriting-History