Problem/Motivation

Currently, people looking for ways to report an issue they have found have no way to know where to go. They know that Drupal is open source, so might come in via /community and we need to connect them to the right people and places to do this.

Remaining tasks

(reviews needed, tests to be written or run, documentation to be written, etc.)

Proposed resolution

I propose the following “I want heading” to be added to /community:


Add the content you want to be added to the website, according to the format described below. You should refer to the Content Guidelines for Documentation for language style and #3003061: [META] Description of page layout and requirements for headings for a wider understanding of final layout.

I want to: report a software or documentation issue that I have found

If you find a problem with the Drupal software or documentation, it will be a great benefit to the Drupal community if you report it, so it can be fixed or addressed. Each project on Drupal.org (Drupal core, modules, themes, and distributions) has its own public area for issue tracking, known as an issue queue, where anyone can report and collaborate on fixing issues. There is also a project called "Documentation", where issues with the documentation on Drupal.org are located. Security issues are handled in a separate, confidential issue queue, to ensure that they are fixed before vulnerabilities become public.

The following groups are actively engaged in this area:

Drupal documentation is constantly evolving. You can read about issue reporting and project maintenance processes at:

You can connect with other members of the Drupal community, collaborating on issues, through:

Comments

rachel_norfolk created an issue. See original summary.

rachel_norfolk’s picture

Status: Active » Needs review

Added some starter text but struggling to think of a link to whoever "owns" issues as such. All suggestions welcome!

jhodgdon’s picture

This looks pretty good to me!

I'm not sure what you mean in comment #2 about "ownership"... but I think it would be good to mention that each sub-project within the Drupal community has its own issue area.

I think it might also be good to avoid use of the word "queue" without explaining it. We do call them issue queues, but that could be confusing to a new member of the community coming to the page.

So, I suggest this revision for the second sentence and third paragraph:

Each project on Drupal.org (Drupal Core, modules, themes, and distributions) has its own public area for issue tracking, known as an issue queue, where anyone can report and collaborate on fixing issues. Security issues are handled in a separate, confidential issue queue, to ensure that they are fixed before vulnerabilities become public.

Then in the list of groups actively involved, I would add
* Maintainers of individual modules, themes, and distributions

rachel_norfolk’s picture

Issue summary: View changes
rachel_norfolk’s picture

Issue summary: View changes
bramdriesen’s picture

On the beta page there seems to be a strange <br> tag.

<a href="/security-team/report-issue">using<br>
                    their guide</a>
bramdriesen’s picture

And another one:

<a href="https://drupalslack.herokuapp.com/">sign up to<br>
                    drupal.slack.com</a>
bramdriesen’s picture

Issue summary: View changes

Added capital letters to the "You can connect with other members" unordered list.

rachel_norfolk’s picture

urgh - yeah, it's the auto-inserted line breaks because the input filter is getting confused by me formatting the html. That's my fault. Essentially, I'm copying all of the content out of the individual issues into VSCode, making a html file and then pasting that into the editor for the page. It's a bit temporary until we make a fancy UI

jhodgdon’s picture

Issue summary: View changes

Fix a couple of typos in the text, and made the bullet list more consistent with its header (which ends in "... through:".

Also... the link to report security issues... one place it is /security-team/report-issue and in another it is node/101494. ???

bramdriesen’s picture

rachel_norfolk’s picture

Issue summary: View changes
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

This looks excellent to me! I think it is probably ready for RTBC?

bramdriesen’s picture

Yes looks good!

rachel_norfolk’s picture

Excellent! I'll set the issue to Fixed once I've copied the content onto the page. Thank you!

gdemet’s picture

I'm wondering if it makes sense to change the name of this section to "I want to report an issue with the software or documentation" so that it's more clear that this is distinct from reporting code of conduct or other issues?

gdemet’s picture

Status: Reviewed & tested by the community » Needs review
jhodgdon’s picture

Title: Add Section Heading “I want to report an issue I have found” » Add Section Heading “I want to report a software or documentation issue I have found”
Issue summary: View changes

I think that is an excellent idea. Way to go, channeling the Drupal newcomer who may not understand that by 'issue' we mean something very specific!

Also, since you bring up documentation issues, we should add some notes about that, because it may not be obvious how/where to report docs issues. So, I added some content there.

Also updated for the new chat standard text... needs review again!

rachel_norfolk’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

updated urls for internal pages. Looks great! RTBC

lizzjoy’s picture

I think it's nearly there. But if I'm a newcomer who finds this page, I may think "where do I find the maintainers of individual modules? or of Core? or of this site itself?" Is there a page or graphic that explains where to see this information? If not, would a screenshot be helpful? Do maintainers get messages via d.o contact form currently? If so, mentioning etiquette on using Contact form would be helpful here or on a subsequent page.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Setting to Needs Work for #20.

My thoughts on that: Good point!

As a contrib maintainer, I want to have people who think they have found a problem with the software to create an issue. I absolutely do not want them to contact me using my d.o contact form. I consider that to be somewhat rude, because then I have to create an issue so that I can track the problem, so that there is a record of it (even if it's not determined to be an actual software bug, having a record of what someone thought was a bug can be useful for the next person who thinks the same).

I think most contrib maintainers feel the same way, and it's also definitely true for Drupal Core.

So, I think it would be a good idea to put in a sentence or two explaining that contacting the software maintainers directly is not encouraged, rather than just (as this section does now) saying to use the issue queues.

I absolutely do not think we should be highlighting how to figure out who the maintainers of a module are. We really don't want to encourage people to contact them via social media or contact forms. We need the issues.

That is my opinion anyway...

jhodgdon’s picture

I posted a link to this issue in the #contribute Slack channel, to see if other module/theme/core maintainers have opinions on this (#21 is just my opinion really).

borisson_’s picture

As a contrib maintainer, I want to have people who think they have found a problem with the software to create an issue. I absolutely do not want them to contact me using my d.o contact form. I consider that to be somewhat rude, because then I have to create an issue so that I can track the problem, so that there is a record of it (even if it's not determined to be an actual software bug, having a record of what someone thought was a bug can be useful for the next person who thinks the same).

I agree with this.

andypost’s picture

Yep, it needs to elaborate because mails could get lost but issues will keep history "forever" (event if report is duplicate)
Moreover contact form has no docs about its usage (I recall only "dealing abandoned projects" case) also people can disable contact form access

jhodgdon’s picture

Issue summary: View changes
Status: Needs work » Needs review

OK... assuming most other contrib maintainers agree with me (and I'm sure Core maintainers don't want to get contact form email about bugs!), I'll update the text a bit. Thoughts?

darvanen’s picture

I agree with #21.

Also some modules have more than one active maintainer so contacting directly can be hit/miss. Issues are much more efficient.

I do see a bit of frustration on issue queues when maintainers haven't responded in a while (which has led to me offering to maintain a couple of modules). I think useful meta information here might include:

  • What the role of a maintainer is
    • Just check and commit RTBC patches?
    • Review and commit?
    • Fix the entire bug by themselves?
    • Changes from module to module (i.e. avoid assumptions)?
  • What sort of timeframes are considered appropriate in this community
    • i.e. please don't demand an answer one hour after posting an issue
  • How to get help when you're really stuck
    • Rather than just mention Slack - indicate that it's a good place for real-time support, especially in the #support channel

I know a lot of this is covered elsewhere... but people don't go looking for it :)

jhodgdon’s picture

Issue summary: View changes

Good points in #26. I located some documentation about maintainership, and am adding links to the text. Thoughts?

jhodgdon’s picture

Oh, regarding "How to get help when you're really stuck"... I think that should be a separate section, and I don't think it's covered in this one, which is about how to report a software or docs bug. Oh yeah, we already have #3004623: Add Section Heading “I want to find help installing and using Drupal”, so I think we should leave it to that section to cover how to get help when you're stuck.

darvanen’s picture

Looks great, makes sense, no further feedback from me :)

bramdriesen’s picture

Status: Needs review » Reviewed & tested by the community

Looks very complete to me! Great work.

Dan_Lind’s picture

The text is helpful! Looks great to me!

rachel_norfolk’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Fixed

Updated format to match accordion control and copied text for inclusion on page

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.