← Back to branch summary

~ubuntu-branches/debian/sid/neovim/sid

« back to all changes in this revision

Viewing changes to CONTRIBUTING.md

  • Committer: Package Import Robot
  • Author(s): James McCoy
  • Date: 2016-02-20 22:41:32 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: package-import@ubuntu.com-20160220224132-e24n8lh3yo5ylt23
Tags: upstream-0.1.2
Import upstream version 0.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
CONTRIBUTING.md
23
23
  your problem persists.
24
24
- If you're experiencing compile or runtime warnings/failures, try searching for
25
25
  the error message(s) you received (if any) on [Neovim's issue tracker][github-issues].
26
 
    - For build issues, see
27
 
      [Troubleshooting#build-issues][wiki-troubleshooting-build-issues].
28
 
    - For runtime issues, see
29
 
      [Troubleshooting#runtime-issues][wiki-troubleshooting-runtime-issues].
30
 
      If your issue isn't mentioned there, try reproducing it using `nvim`
31
 
      with the smallest possible `vimrc` (or none at all via `nvim -u NONE`),
32
 
      to rule out bugs in plugins you're using.
33
 
      If you're using a plugin manager, comment out your plugins, then add
34
 
      them back in one by one.
 
26
- For runtime issues, try reproducing it using `nvim` with the smallest
 
27
  possible `vimrc` (or none at all via `nvim -u NONE`), to rule out bugs in
 
28
  plugins you're using. If you're using a plugin manager, comment out your
 
29
  plugins, then add them back in one by one.
35
30
 
36
31
Include as much detail as possible; we generally need to know:
37
32
 
112
107
otherwise prefer to leave things as they are.
113
108
 
114
109
For new code, run `make lint` (which runs [clint.py][clint]) to detect style
115
 
errors. Make sure that the file(s) you intend to be linted are not in
116
 
`clint-ignored-files.txt`. It's not perfect, so some warnings may be false
117
 
positives/negatives. To have `clint.py` ignore certain cases, put `// NOLINT`
118
 
at the end of the line.
 
110
errors. It's not perfect, so some warnings may be false positives/negatives.
 
111
To have `clint.py` ignore certain cases, put `// NOLINT` at the end of the
 
112
line.
119
113
 
120
114
We also provide a configuration file for [`clang-format`][clang-format], which
121
115
can be used to format code according to the style guidelines. Be aware that
196
190
[wiki-contributing]: https://github.com/neovim/neovim/wiki/Contributing
197
191
[wiki-faq]: https://github.com/neovim/neovim/wiki/FAQ
198
192
[wiki-review-checklist]: https://github.com/neovim/neovim/wiki/Code-review-checklist
199
 
[wiki-troubleshooting-build-issues]: https://github.com/neovim/neovim/wiki/Troubleshooting#build-issues
200
 
[wiki-troubleshooting-runtime-issues]: https://github.com/neovim/neovim/wiki/Troubleshooting#runtime-issues
201
193
[wiki-troubleshooting]: https://github.com/neovim/neovim/wiki/Troubleshooting