Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[READY] Signpost the contact details earlier in the README #2866

Merged
merged 1 commit into from
Jan 1, 2018

Conversation

puremourning
Copy link
Member

@puremourning puremourning commented Dec 31, 2017

PR Prelude

Thank you for working on YCM! :)

Please complete these steps and check these boxes (by putting an x inside
the brackets) before filing your PR:

  • I have read and understood YCM's CONTRIBUTING document.
  • I have read and understood YCM's CODE_OF_CONDUCT document.
  • I have included tests for the changes in my PR. If not, I have included a
    rationale for why I haven't.
  • I understand my PR may be closed if it becomes obvious I didn't
    actually perform all of these steps.

Why this change is necessary and useful

At the request of the nice folk over at #vim on free node, this PR signposts the contact details and installation instructions at the top of the readme so that users seeking help use our contact details, rather than asking over there.

Overall it is better for users to seek support from us because:

  • we have better knowledge and can solve issues more quickly
  • we get better visibility of in-the-wild issues and sticking points
  • certain #vim users feel that they are unduly burdened with supporting setup issues for YCM

cc @romainl


This change is Reviewable

@codecov-io
Copy link

codecov-io commented Dec 31, 2017

Codecov Report

Merging #2866 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2866   +/-   ##
=======================================
  Coverage   92.36%   92.36%           
=======================================
  Files          20       20           
  Lines        1965     1965           
=======================================
  Hits         1815     1815           
  Misses        150      150

@bstaletic
Copy link
Collaborator

Reviewed 1 of 1 files at r1.
Review status: all files reviewed at latest revision, 1 unresolved discussion.


README.md, line 27 at r1 (raw file):

get in touch.

Please do **NOT** go to #vim on freenode for support. Please contact the

Should we also mention /r/vim on reddit along with #vim on freenode?


Comments from Reviewable

@puremourning
Copy link
Member Author

Review status: all files reviewed at latest revision, 1 unresolved discussion.


README.md, line 27 at r1 (raw file):

Previously, bstaletic (Boris Staletic) wrote…

Should we also mention /r/vim on reddit along with #vim on freenode?

Nobody on /r/vim is moaning at me, so i'm not sure. The #vim people specifically mentioned it which is why i put this in. There are an infinite number of other places not to go...


Comments from Reviewable

@puremourning puremourning changed the title Signpost the contact details earlier in the README [READY] Signpost the contact details earlier in the README Dec 31, 2017
@micbou
Copy link
Collaborator

micbou commented Dec 31, 2017

:lgtm:


Reviewed 1 of 1 files at r1.
Review status: all files reviewed at latest revision, 1 unresolved discussion.


Comments from Reviewable

@bstaletic
Copy link
Collaborator

Okay, forget reddit. :lgtm:

@zzbot r=micbou


Review status: all files reviewed at latest revision, 1 unresolved discussion.


README.md, line 27 at r1 (raw file):

Previously, puremourning (Ben Jackson) wrote…

Nobody on /r/vim is moaning at me, so i'm not sure. The #vim people specifically mentioned it which is why i put this in. There are an infinite number of other places not to go...

I asked because I know people who ask on reddit get moaned at and sent to our issue tracker.

Confession time: I let that happen more than once without replying to the post on reddit.


Comments from Reviewable

@zzbot
Copy link
Contributor

zzbot commented Dec 31, 2017

📌 Commit cd1bd45 has been approved by micbou

@zzbot
Copy link
Contributor

zzbot commented Dec 31, 2017

⌛ Testing commit cd1bd45 with merge ad41dfb...

zzbot added a commit that referenced this pull request Dec 31, 2017
[READY] Signpost the contact details earlier in the README

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [x] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

At the request of the nice folk over at `#vim` on free node, this PR signposts the contact details and installation instructions at the top of the readme so that users seeking help use our contact details, rather than asking over there.

Overall it is better for users to seek support from us because:

* we have better knowledge and can solve issues more quickly
* we get better visibility of in-the-wild issues and sticking points
* certain #vim users feel that they are unduly burdened with supporting setup issues for YCM

cc @romainl

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2866)
<!-- Reviewable:end -->
@zzbot
Copy link
Contributor

zzbot commented Jan 1, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: micbou
Pushing ad41dfb to master...

@zzbot zzbot merged commit cd1bd45 into ycm-core:master Jan 1, 2018
@bstaletic bstaletic mentioned this pull request Nov 1, 2018
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants