kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-25 05:35:10 -07:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: Remove outdated info

Browse Source 
- Remove mention of "build-issues" and "runtime-issues" sections from
  the "Troubleshooting" page; they're already mentioned at the top of
  the section: "Before reporting an issue, see the ...".

- As of [1], clint-ignored-files.txt isn't used anymore.

[1]: 57eaefbb23
This commit is contained in:
Michael Reed 2016-01-08 17:43:48 -05:00
parent d51a27b7e5
commit 94fabe4d59
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -23,15 +23,10 @@ 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 build issues, see - For runtime issues, try reproducing it using `nvim` with the smallest
[Troubleshooting#build-issues][wiki-troubleshooting-build-issues]. possible `vimrc` (or none at all via `nvim -u NONE`), to rule out bugs in
- For runtime issues, see plugins you're using. If you're using a plugin manager, comment out your
[Troubleshooting#runtime-issues][wiki-troubleshooting-runtime-issues]. plugins, then add them back in one by one.
If your issue isn't mentioned there, try reproducing it using `nvim`
with the smallest possible `vimrc` (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:
@ -112,10 +107,9 @@ happen to be modifying anyway. Fix anything that looks outright
otherwise prefer to leave things as they are. otherwise prefer to leave things as they are.
For new code, run `make lint` (which runs [clint.py][clint]) to detect style For new code, run `make lint` (which runs [clint.py][clint]) to detect style
errors. Make sure that the file(s) you intend to be linted are not in errors. It's not perfect, so some warnings may be false positives/negatives.
`clint-ignored-files.txt`. It's not perfect, so some warnings may be false To have `clint.py` ignore certain cases, put `// NOLINT` at the end of the
positives/negatives. To have `clint.py` ignore certain cases, put `// NOLINT` line.
at the end of the line.
We also provide a configuration file for [`clang-format`][clang-format], which We also provide a configuration file for [`clang-format`][clang-format], which
can be used to format code according to the style guidelines. Be aware that can be used to format code according to the style guidelines. Be aware that
@ -196,6 +190,4 @@ such as [`tig`][tig].
[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-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