vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More updates to CONTRIBUTING.md

Browse Source
This commit is contained in:
Strahinja Val Markovic 2013-05-29 19:12:20 -07:00
parent 612ab6e43a
commit cb74e33741
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -26,7 +26,8 @@ one. There's no point in duplication; if an existing issue addresses your
problem, please comment there instead of creating a duplicate. problem, please comment there instead of creating a duplicate.
Lastly, **make sure you are running the latest version of YCM**. The issue you Lastly, **make sure you are running the latest version of YCM**. The issue you
have encountered may have already been fixed. have encountered may have already been fixed. **Don't forget to recompile
ycm_core.so too** (usually by just running `install.sh` again).
OK, so we've reached this far. You need to create an issue. First realize that 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 the time it takes to fix your issue is a multiple of how long it takes the
@ -35,9 +36,9 @@ fixed.
Here are the things you should do when creating an issue: Here are the things you should do when creating an issue:
1. **Write a step-by-step sequence of steps that repeatedly reproduce your 1. **Write a step-by-step procedure that when performed repeatedly reproduces
issue.** If we can't reproduce the issue, then we can't fix it. It's that your issue.** If we can't reproduce the issue, then we can't fix it. It's
simple. that simple.
2. **Create a test case for your issue**. This is critical. Don't talk about how 2. **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 "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 the contents inside code blocks in your issue description. Try to make this