170 lines
8.6 KiB
Markdown
170 lines
8.6 KiB
Markdown
|
Writing issue reports
|
|||
|
|
=====================
|
|||
|
|
|
|||
|
|
### Bugs and features only
|
|||
|
|
|
|||
|
|
First things first: **the issue tracker is NOT for tech support**. It is for
|
|||
|
|
reporting bugs and requesting features. If your issue amounts to "I can't get
|
|||
|
|
YCM to work on my machine" and the reason why is obviously related to your
|
|||
|
|
machine configuration and the problem would not be resolved with _reasonable_
|
|||
|
|
changes to the YCM codebase, then the issue is likely to be closed.
|
|||
|
|
|
|||
|
|
### Where to go for help
|
|||
|
|
|
|||
|
|
**A good place to ask questions is the [Gitter room][gitter] or the
|
|||
|
|
[ycm-users][] Google group**. Rule of thumb: if you're not sure whether your
|
|||
|
|
problem is a real bug, ask on the room or the group.
|
|||
|
|
|
|||
|
|
Don't go to `#vim` on freenode for support. See the
|
|||
|
|
[readme][help-advice-support] for further help.
|
|||
|
|
|
|||
|
|
### Installation problem - read the docs
|
|||
|
|
|
|||
|
|
**YCM compiles just fine**; [the build bots say so][build-bots]. If the bots are
|
|||
|
|
green and YCM doesn't compile on your machine, then _your machine is the root
|
|||
|
|
cause_. Now read the first paragraph again.
|
|||
|
|
|
|||
|
|
Realize that quite literally _thousands_ of people have gotten YCM to work
|
|||
|
|
successfully so if you can't, it's probably because you have a peculiar
|
|||
|
|
system/Vim configuration or you didn't go through the docs carefully enough.
|
|||
|
|
It's very unlikely to be caused by an actual bug in YCM because someone would
|
|||
|
|
have already found it and reported it.
|
|||
|
|
|
|||
|
|
This leads us to point #2: **make sure you have checked the docs before
|
|||
|
|
reporting an issue**. The docs are extensive and cover a ton of things; there's
|
|||
|
|
also an FAQ at the bottom that quite possibly addresses your problem.
|
|||
|
|
|
|||
|
|
For installation problems, make sure that any issue report includes the entire
|
|||
|
|
output of any build or installation commands, including **the command used to
|
|||
|
|
run them**.
|
|||
|
|
|
|||
|
|
For common issues such as "the ycmd server SHUT DOWN", please check the GitHub
|
|||
|
|
Wiki.
|
|||
|
|
|
|||
|
|
### Other problems - check the issue tracker
|
|||
|
|
|
|||
|
|
Further, **search the issue tracker for similar issues** before creating a new
|
|||
|
|
one. There's no point in duplication; if an existing issue addresses your
|
|||
|
|
problem, please comment there instead of creating a duplicate. However, if the
|
|||
|
|
issue you found is **closed as resolved** (e.g. with a PR or the original user's
|
|||
|
|
problem was resolved), raise a **new issue**, because you've found a new
|
|||
|
|
problem. Reference the original issue if you think that's useful information.
|
|||
|
|
|
|||
|
|
Please note: Closed issues which have been inactive for 60 days will be locked,
|
|||
|
|
this helps to keep discussions focussed. If you believe you are still
|
|||
|
|
experiencing an issue which has been closed, please raise a new issue,
|
|||
|
|
completing the issue template.
|
|||
|
|
|
|||
|
|
If you do find a similar _open_ issue, **don't just post 'me too' or similar**
|
|||
|
|
responses. This almost never helps resolve the issue, and just causes noise for
|
|||
|
|
the maintainers. Only post if it will aid the maintainers in solving the issue;
|
|||
|
|
if there are existing diagnostics requested in the thread, perform
|
|||
|
|
them and post the results.
|
|||
|
|
|
|||
|
|
When replying, follow the instructions for getting the required diagnostics for
|
|||
|
|
posting a new issue (see below), and add them to your response. This is likely
|
|||
|
|
to help the maintainers find a fix for you, rather than have them spend time
|
|||
|
|
requesting them again. To be clear, the maintainers *always* need the
|
|||
|
|
diagnostics (debug info, log files, versions, etc.) even for responses on
|
|||
|
|
existing issues.
|
|||
|
|
|
|||
|
|
You should also **search the archives of the [ycm-users][] mailing list**.
|
|||
|
|
|
|||
|
|
### Check your YCM version
|
|||
|
|
|
|||
|
|
Lastly, **make sure you are running the latest version of YCM**. The issue you
|
|||
|
|
have encountered may have already been fixed. **Don't forget to recompile
|
|||
|
|
ycm_core.so too** (usually by just running `install.py` again).
|
|||
|
|
|
|||
|
|
## Creating an issue
|
|||
|
|
|
|||
|
|
OK, so we've reached this far. You need to create an issue. First realize that
|
|||
|
|
the time it takes to fix your issue is a multiple of how long it takes the
|
|||
|
|
developer to reproduce it. The easier it is to reproduce, the quicker it'll be
|
|||
|
|
fixed.
|
|||
|
|
|
|||
|
|
Here are the things you should do when creating an issue:
|
|||
|
|
|
|||
|
|
1. Most importantly, **read and complete the issue template**. The maintainers
|
|||
|
|
rely on the style and structure of the issue template to quickly resolve your
|
|||
|
|
issue. If you don't complete it in full, then the maintainers may elect to
|
|||
|
|
ignore or simply close your issue. This isn't personal, it's just that they
|
|||
|
|
are busy too.
|
|||
|
|
2. **Check that your issue reproduces with a minimal configuration**. Run `vim
|
|||
|
|
-Nu /path/to/YCM/vimrc_ycm_minimal` and reproduce this issue. If it doesn't
|
|||
|
|
repro, then copy your ycm-specific settings into this file and try again. If
|
|||
|
|
it still doesn't repro, the issue is likely with another plugin.
|
|||
|
|
3. **Write a step-by-step procedure that when performed repeatedly reproduces
|
|||
|
|
your issue.** If we can't reproduce the issue, then we can't fix it. It's
|
|||
|
|
that simple.
|
|||
|
|
4. Explain **what you expected to happen**, and **what actually happened**.
|
|||
|
|
This helps us understand if it is a bug, or just a misunderstanding of the
|
|||
|
|
behavior.
|
|||
|
|
5. Add the output of [the `:YcmDebugInfo` command][ycm-debug-info-command]. Make
|
|||
|
|
sure that when you run this, your cursor is in the file that is experiencing
|
|||
|
|
the issue.
|
|||
|
|
6. Reproduce your issue using `vim -Nu /path/to/YCM/vimrc_ycm_minimal`
|
|||
|
|
and attach the contents of the logfiles. Use [the
|
|||
|
|
`:YcmToggleLogs` command][ycm-toggle-logs-command] to directly open them in
|
|||
|
|
Vim.
|
|||
|
|
7. **Create a test case for your issue**. This is critical. Don't talk about how
|
|||
|
|
"when I have X in my file" or similar, _create a file with X in it_ and put
|
|||
|
|
the contents inside code blocks in your issue description. Try to make this
|
|||
|
|
test file _as small as possible_. Don't just paste a huge, 500 line source
|
|||
|
|
file you were editing and present that as a test. _Minimize_ the file so that
|
|||
|
|
the problem is reproduced with the smallest possible amount of test data.
|
|||
|
|
8. **Include your OS and OS version.**
|
|||
|
|
9. **Include the output of `vim --version`.**
|
|||
|
|
|
|||
|
|
|
|||
|
|
Creating good pull requests
|
|||
|
|
===========================
|
|||
|
|
|
|||
|
|
1. **Follow the code style of the existing codebase.**
|
|||
|
|
- The Python code **DOES NOT** follow PEP 8. This is not an oversight, this
|
|||
|
|
is by choice. You can dislike this as much as you want, but you still need
|
|||
|
|
to follow the existing style. Look at other Python files to see what the
|
|||
|
|
style is.
|
|||
|
|
- The C++ code has an automated formatter (`style_format.sh` that runs
|
|||
|
|
`astyle`) but it's not perfect. Again, look at the other C++ files and
|
|||
|
|
match the code style you see.
|
|||
|
|
- Same thing for VimScript. Match the style of the existing code.
|
|||
|
|
|
|||
|
|
2. **Your code needs to be well written and easy to maintain**. This is of the
|
|||
|
|
_utmost_ importance. Other people will have to maintain your code so don't
|
|||
|
|
just throw stuff against the wall until things kinda work.
|
|||
|
|
|
|||
|
|
3. **Split your pull request into several smaller ones if possible.** This
|
|||
|
|
makes it easier to review your changes, which means they will be merged
|
|||
|
|
faster.
|
|||
|
|
|
|||
|
|
4. **Write tests for your code**. If you're changing the VimScript code then
|
|||
|
|
you don't have to since it's hard to test that code. This is also why you
|
|||
|
|
should strive to implement your change in Python if at all possible (and if
|
|||
|
|
it makes sense to do so). Python is also _much_ faster than VimScript.
|
|||
|
|
|
|||
|
|
5. **Explain in detail why your pull request makes sense.** Ask yourself, would
|
|||
|
|
this feature be helpful to others? Not just a few people, but a lot of YCM’s
|
|||
|
|
users? See, good features are useful to many. If your feature is only useful
|
|||
|
|
to you and _maybe_ a couple of others, then that’s not a good feature.
|
|||
|
|
There is such a thing as “feature overload”. When software accumulates so
|
|||
|
|
many features of which most are only useful to a handful, then that software
|
|||
|
|
has become “bloated”. We don’t want that.
|
|||
|
|
|
|||
|
|
Requests for features that are obscure or are helpful to but a few, or are
|
|||
|
|
not part of YCM's "vision" will be rejected. Yes, even if you provide a
|
|||
|
|
patch that completely implements it.
|
|||
|
|
|
|||
|
|
Please include details on exactly what you would like to see, and why. The
|
|||
|
|
why is important - it's not always clear why a feature is really useful. And
|
|||
|
|
sometimes what you want can be done in a different way if the reason for the
|
|||
|
|
change is known. _What goal is your change trying to accomplish?_
|
|||
|
|
|
|||
|
|
|
|||
|
|
[build-bots]: https://dev.azure.com/YouCompleteMe/YCM/_build/latest?definitionId=1&branchName=master
|
|||
|
|
[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users
|
|||
|
|
[gitter]: https://gitter.im/Valloric/YouCompleteMe
|
|||
|
|
[help-advice-support]: https://github.com/ycm-core/YouCompleteMe#help-advice-support
|
|||
|
|
[ycm-debug-info-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmdebuginfo-command
|
|||
|
|
[ycm-toggle-logs-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmtogglelogs-command
|