From affe3e8d312753ba3ec8f7d476a49c0190a55fb5 Mon Sep 17 00:00:00 2001 From: Strahinja Val Markovic Date: Sat, 13 Jul 2013 11:38:34 -0700 Subject: [PATCH] Docs now mention the new ycm-users mailing list --- CONTRIBUTING.md | 6 ++++++ README.md | 15 +++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e0c8688..66fab962 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,9 @@ 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. +**A good place to ask questions is the [ycm-users][] Google group**. Rule of +thumb: if you're not sure whether your problem is a real bug, ask on the group. + **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 previous paragraph again. @@ -25,6 +28,8 @@ 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. +You should also **search the archives of the [ycm-users][] mailing list**. + 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.sh` again). @@ -80,3 +85,4 @@ Creating good pull requests change is known. _What goal are you trying to accomplish?_ [build-bots]: https://travis-ci.org/Valloric/YouCompleteMe +[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users diff --git a/README.md b/README.md index cd526bd1..e6ea221b 100644 --- a/README.md +++ b/README.md @@ -1270,12 +1270,22 @@ You'll have to learn to ignore them. It's a shitty "solution", I know. Use the [delimitMate][] plugin instead. It does the same thing without conflicting with YCM. +### Is there some sort of YCM mailing list? I have questions + +If you have questions about the plugin or need help, please use the +[ycm-users][] mailing list, _don't_ create issues on the tracker. The tracker is +for bug reports and feature requests. Contact ------- -If you have questions, bug reports, suggestions, etc. please use the [issue -tracker][tracker]. The latest version is available at +If you have questions about the plugin or need help, please use the +[ycm-users][] mailing list. + +If you have bug reports or feature suggestions, please use the [issue +tracker][tracker]. + +The latest version of the plugin is available at . The author's homepage is . @@ -1314,3 +1324,4 @@ This software is licensed under the [GPL v3 license][gpl]. [exuberant-ctags]: http://ctags.sourceforge.net/ [ctags-format]: http://ctags.sourceforge.net/FORMAT [vundle-bug]: https://github.com/gmarik/vundle/issues/48 +[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users