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

Adding support and issue template docs to .scrapy #3126

Closed

Conversation

cathalgarvey
Copy link
Contributor

@cathalgarvey cathalgarvey commented Feb 15, 2018

Adding these 'magic files' will make Github show a template on new issues, encouraging them to seek support elsewhere, and a pop-up with a link to a "Support" document above the new issue box.

The idea is to gently discourage issues-as-support-requests, without discouraging bug reports, feature requests, or security issues.


Otherwise, feel free to delete the above and make your issue!
If it's a bug, try to make it reproducible and minimal.
But don't sweat it. Thanks for contributing to Scrapy! :)
Copy link
Member

@lopuhin lopuhin Feb 15, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, maybe it makes sense to remove "But don't sweat it.", and write "try to make it reproducible and minimal if possible" or something like this? It's an idiom that might be not 100% clear for everyone, I already knew it and still needed some time to understand what does it mean here :)

Copy link
Contributor

@djunzu djunzu Feb 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.
Many people here does not have English as first or second language (many depend on google translator and similar) so I think it is better to have a clear and direct text, without any "popular expression"[1] like "don't sweat it"[2].

[1] There is a correct name in the grammar for this kind of stuff. But as you can guess, my English is not good...
[2] I have no idea what it means. Going google it now...

@codecov
Copy link

codecov bot commented Feb 15, 2018

Codecov Report

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

@@          Coverage Diff           @@
##           master   #3126   +/-   ##
======================================
  Coverage    82.1%   82.1%           
======================================
  Files         228     228           
  Lines        9586    9586           
  Branches     1384    1384           
======================================
  Hits         7871    7871           
  Misses       1456    1456           
  Partials      259     259

@cathalgarvey
Copy link
Contributor Author

cathalgarvey commented Feb 15, 2018

This repository's "Issues" pane is not the place to request support
or advice on using Scrapy. For that, we suggest joining the [Scrapy
community][community] over at:

Copy link
Contributor

@djunzu djunzu Feb 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me suggest:

This repository's "Issues" pane is used only for bug reports and feature
requests. If you have a "how to" or "is it possible" question or if you need
support/advice on using Scrapy, we suggest joining the [Scrapy
+community][community] over at:

Or something thing like that.

I think saying explicitly that "how to" questions don't belong here will help a lot avoid them.

_usage_ of Scrapy, however, please consider posting instead
to a more appropriate forum: We support Reddit, IRC, and Stack
Overflow. Check our Community portal for details:
https://scrapy.org/community/
Copy link
Member

@kmike kmike Feb 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should link to the SUPPORT.md document here, to be a bit more consistent. There are too many pages to keep in sync already:

@kmike
Copy link
Member

kmike commented Feb 16, 2018

I wonder if it is possible to show this information only to first-time contributors; it is a bit annoying to delete these templates each time you write an issue. For example, at https://github.com/googlesamples/google-services/issues/new I like there is a link to contribution guidelines, but I don't like the huge formal issue template. Just a personal opinion :)

@elacuesta
Copy link
Member

elacuesta commented Dec 10, 2018

I'm commenting here just to get the ball rolling. I think this is a much needed improvement, given the amount of support questions the issue tracker is getting lately. Actual bug reports and feature requests are getting buried.
I've been answering a few issues including at the end (what I think is) a polite message asking to go to other channels for support questions, I hope you don't think it's too harsh or discouraging (by all means, please let me know if you do). Something like "In addition, in the future please refrain from posting support questions in the Github issue tracker. There are more appropiate channels for these kind of questions, like the scrapy tag in StackOverflow (see https://scrapy.org/community/ for a comprehensive list of resources). This channel should be reserved for bug reports and feature requests. Thanks for your understanding."

@Gallaecio
Copy link
Member

Gallaecio commented Jul 29, 2019

OK, so lets close this pull request and move #3471 forward.

@Gallaecio Gallaecio closed this Jul 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants