Figure out where to put bug tracker directions #1824

Closed
mgol opened this Issue Oct 30, 2014 · 5 comments

Comments

Projects
None yet
2 participants
@mgol
Member

mgol commented Oct 30, 2014

Since we migrated from Trac, we no longer have the introduction text from http://bugs.jquery.com presented. Each new bug has an attached link to CONTRIBUTING.md with text: "Please review the guidelines for contributing to this repository.". This suggests we might want to put a variation of this text in this file.

The question is: where? Near the beginning? In the "How to Report Bugs" section?

For reference the text from http://bugs.jquery.com:

Thanks for coming to report a bug or suggest a feature for jQuery! Before reporting, please take a minute to make sure this is the right place to file your issue.

jQuery plugins: Report your bug to its author, not here.

jQuery Core API Documentation issues: Problems with the documentation should be reported to  api.jquery.com GitHub repository.

jQuery web site issues: Use the trackers in the  individual repos for each site by its domain name, e.g.,  api.jquery.com,  jquery.com. Web site issues may also lie in  jquery-wp-content, and can be filed there if appropriate. If you file an web site issue in the wrong place, we will work to make sure it ends up in the right place, however the jQuery core bug tracker is not that place.

jQuery UI (Tabs, Dialog, etc.): Use the  jQuery UI bug tracker.

jQuery Mobile: Use the  jQuery Mobile GitHub tracker.

jQuery core bugs only: Follow these instructions.

@mgol

This comment has been minimized.

Show comment
Hide comment
Member

mgol commented Oct 30, 2014

@mgol mgol added this to the 3.0.0 milestone Oct 30, 2014

@dmethvin

This comment has been minimized.

Show comment
Hide comment
@dmethvin

dmethvin Oct 30, 2014

Member

This is a surprisingly hard problem, eh? I think our current CONTRIBUTING.MD file is too long and people aren't reading it. There's also some overlap with the content at http://contribute.jquery.org.

As a quick patch I would say that content above belongs in the "Make sure it is a jQuery bug" section. That doesn't fix the problem of there being too much to read though.

Member

dmethvin commented Oct 30, 2014

This is a surprisingly hard problem, eh? I think our current CONTRIBUTING.MD file is too long and people aren't reading it. There's also some overlap with the content at http://contribute.jquery.org.

As a quick patch I would say that content above belongs in the "Make sure it is a jQuery bug" section. That doesn't fix the problem of there being too much to read though.

@mgol

This comment has been minimized.

Show comment
Hide comment
@mgol

mgol Oct 30, 2014

Member

We haven't been directing people to this file, pointing to http://contribute.jquery.org instead. Perhaps we can remove most of the content (making sure all that's relevant is on the site) putting there this short notice instead that would itself direct to the site as well?

Member

mgol commented Oct 30, 2014

We haven't been directing people to this file, pointing to http://contribute.jquery.org instead. Perhaps we can remove most of the content (making sure all that's relevant is on the site) putting there this short notice instead that would itself direct to the site as well?

@dmethvin

This comment has been minimized.

Show comment
Hide comment
@dmethvin

dmethvin Oct 30, 2014

Member

We've been using a template for this in most of our other sites that points back to the Contribute site, see https://github.com/jquery/jquery.com/blob/master/CONTRIBUTING.md for example. Maybe we could just use that and work in the discussion about getting to the right place because I suspect that the jQuery core repo is the one most likely to get misdirected requests.

Member

dmethvin commented Oct 30, 2014

We've been using a template for this in most of our other sites that points back to the Contribute site, see https://github.com/jquery/jquery.com/blob/master/CONTRIBUTING.md for example. Maybe we could just use that and work in the discussion about getting to the right place because I suspect that the jQuery core repo is the one most likely to get misdirected requests.

@mgol

This comment has been minimized.

Show comment
Hide comment
@mgol

mgol Oct 30, 2014

Member

Good idea!

Member

mgol commented Oct 30, 2014

Good idea!

@dmethvin dmethvin self-assigned this Dec 3, 2014

@dmethvin dmethvin removed this from the 3.0.0 milestone Dec 3, 2014

dmethvin added a commit to dmethvin/jquery that referenced this issue Dec 4, 2014

dmethvin added a commit that referenced this issue Dec 4, 2014

CONTRIBUTING: Condense info and add directions to other resources
Fixes gh-1824
(cherry picked from commit bfd5dab)

Conflicts:
	CONTRIBUTING.md

@dmethvin dmethvin closed this in bfd5dab Dec 4, 2014

@cssmagic cssmagic referenced this issue in cssmagic/ChangeLog May 18, 2016

Open

jQuery #5

@jquery jquery locked as resolved and limited conversation to collaborators Jun 20, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.