From cb74e337411d793923a1e885b3d5d1bfc07ae371 Mon Sep 17 00:00:00 2001 From: Strahinja Val Markovic Date: Wed, 29 May 2013 19:12:20 -0700 Subject: [PATCH] More updates to CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2763ea9..4cea1bdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. 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 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: -1. **Write a step-by-step sequence of steps that repeatedly reproduce your - issue.** If we can't reproduce the issue, then we can't fix it. It's that - simple. +1. **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. 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 the contents inside code blocks in your issue description. Try to make this