mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-16 11:25:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: Fix broken links #2702

Browse Source 
The wiki has had a dedicated "Troubleshooting" page for a while now.
This commit is contained in:
Michael Reed
2015-05-19 03:32:17 -04:00
parent 3c2eae6cc6
commit dac8bcd090
1 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@@ -23,12 +23,15 @@ If your issue isn't mentioned there:
your problem persists. your problem persists.
- If you're experiencing compile or runtime warnings/failures, try searching for - If you're experiencing compile or runtime warnings/failures, try searching for
the error message(s) you received (if any) on [Neovim's issue tracker][github-issues]. the error message(s) you received (if any) on [Neovim's issue tracker][github-issues].
- For installation issues, see [Installing Neovim#troubleshooting][wiki-install-troubleshooting]. - For build issues, see
- For build issues, see [Building Neovim#troubleshooting][wiki-building-troubleshooting]. [Troubleshooting#build-issues][wiki-troubleshooting-build-issues].
- For runtime issues: try to reproduce them by running `nvim` with the - For runtime issues, see
smallest possible `nvimrc` (or none at all via `nvim -u NONE`), to rule [Troubleshooting#runtime-issues][wiki-troubleshooting-runtime-issues].
out bugs in plugins you're using. If you're using a plugin manager, If your issue isn't mentioned there, try to reproduce your it using
comment out your plugins, then add them back in one by one. `nvim` with the smallest possible `nvimrc` (or none at all via `nvim -u
NONE`), to rule out bugs in plugins you're using.
If you're using a plugin manager, comment out your plugins, then add
them back in one by one.
Include as much detail as possible; we generally need to know: Include as much detail as possible; we generally need to know:
@@ -89,9 +92,10 @@ We are unlikely to merge your PR if the Travis build fails:
- Travis builds are compiled with the [`-Werror`][gcc-warnings] flag, so if - Travis builds are compiled with the [`-Werror`][gcc-warnings] flag, so if
your PR introduces any compiler warnings then the Travis build will fail. your PR introduces any compiler warnings then the Travis build will fail.
- If any tests fail, the Travis build will fail. See [Building - If any tests fail, the Travis build will fail.
Neovim#testing][wiki-building-testing] for information on running tests See [Building Neovim#running-tests][wiki-building-running-tests] for
locally. Tests passing locally doesn't guarantee they'll pass in the Travis information on running tests locally.
Tests passing locally doesn't guarantee they'll pass in the Travis
build, as different compilers and platforms will be used. build, as different compilers and platforms will be used.
- Travis runs [Valgrind][valgrind] for the GCC/Linux build, but you may also - Travis runs [Valgrind][valgrind] for the GCC/Linux build, but you may also
do so locally by running the following from a shell: `VALGRIND=1 make test` do so locally by running the following from a shell: `VALGRIND=1 make test`
@@ -191,10 +195,10 @@ such as [`tig`][tig].
[valgrind]: http://valgrind.org/ [valgrind]: http://valgrind.org/
[vcs]: https://en.wikipedia.org/wiki/Revision_control [vcs]: https://en.wikipedia.org/wiki/Revision_control
[waffle]: https://waffle.io/neovim/neovim [waffle]: https://waffle.io/neovim/neovim
[wiki-building-testing]: https://github.com/neovim/neovim/wiki/Building-Neovim#testing [wiki-building-running-tests]: https://github.com/neovim/neovim/wiki/Building-Neovim#running-tests
[wiki-building-troubleshooting]: https://github.com/neovim/neovim/wiki/Building-Neovim#troubleshooting
[wiki-contributing]: https://github.com/neovim/neovim/wiki/Contributing [wiki-contributing]: https://github.com/neovim/neovim/wiki/Contributing
[wiki-faq]: https://github.com/neovim/neovim/wiki/FAQ [wiki-faq]: https://github.com/neovim/neovim/wiki/FAQ
[wiki-install-troubleshooting]: https://github.com/neovim/neovim/wiki/Installing-Neovim#troubleshooting
[wiki-review-checklist]: https://github.com/neovim/neovim/wiki/Code-review-checklist [wiki-review-checklist]: https://github.com/neovim/neovim/wiki/Code-review-checklist
[wiki-troubleshooting-build-issues]: https://github.com/neovim/neovim/wiki/Troubleshooting#build-issues
[wiki-troubleshooting-runtime-issues]: https://github.com/neovim/neovim/wiki/Troubleshooting#runtime-issues
[wiki-troubleshooting]: https://github.com/neovim/neovim/wiki/Troubleshooting [wiki-troubleshooting]: https://github.com/neovim/neovim/wiki/Troubleshooting