Problem/Motivation

State what you believe is wrong or missing from the current standards.

Benefits

If we adopted this change, the Drupal Project would benefit by ...

Three supporters required

  1. https://www.drupal.org/u/{userid} (date that user added support)
  2. https://www.drupal.org/u/{userid} (date that user added support)
  3. https://www.drupal.org/u/{userid} (date that user added support)

Proposed changes

Provide all proposed changes to the Drupal Coding standards. Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:

1. {link to the documentation heading that is to change}

Current text

Add current text in blockquotes

Proposed text

Add proposed text in blockquotes

2. Repeat the above for each page or sub-page that needs to be changed.

Remaining tasks

  1. Create this issue in the Coding Standards queue, using the defined template
  2. Add supporters
  3. Create a Change Record
  4. Review by the Coding Standards Committee
  5. Coding Standards Committee takes action as required
  6. Tagged with 'Needs documentation edits' if Core is not affected
  7. Discussed by the Core Committer Committee, if it impacts Drupal Core
  8. Documentation updates
    1. Edit all pages
    2. Publish change record
    3. Remove 'Needs documentation edits' tag
  9. If applicable, create follow-up issues for PHPCS rules/sniffs changes

For a full explanation of these steps see the Coding Standards project page

Comments

quietone created an issue. See original summary.

jonathan1055’s picture

jonathan1055 commented

Good idea to actually create a new issue with the template. It all looks exactly like the version we had finalised.

Let's leave this issue open for a few days, so that others can see it in action and comment.

One question I had about the process was that often the initial proposed change can vary during the course of the issue. I have seen cases where the proposal has changed enough such that the original person or an early supporter no longer supports the new change, but there are plenty of others who do. So it might be that an individual wants to remove themselves from the supporters list. That's ok, and then new supporters would have to be found. So just wondering if after the user link, we should have the date that they added their support. eg

Then it would be clearer as to what they were supporting.

jonathan1055’s picture

jonathan1055 commented
Issue summary: View changes
Status: Active » Needs review

Updated the issue summary with the proposed change from above.

There may also be other tweaks over the next few weeks as we see and experience how users fill in the template.

quietone’s picture

quietone commented

For a fuller explanation of these steps see

I think that should be 'full' not 'fuller'.

jonathan1055’s picture

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

I agree with #4 and have updated the summary.

Would be good if these actual changes were done in the real template as that's in use now. The IS here I think can be copied and pasted directly into the actual issue template.

quietone’s picture

quietone commented

@jonathan1055, thanks for updating the Issue Summary.

I copied the template from this issue to the project issue template, so they are now in sync. The key difference is that the supporter section is now

Three supporters required

  1. https://www.drupal.org/u/{userid} (date that user added support)
  2. https://www.drupal.org/u/{userid} (date that user added support)
  3. https://www.drupal.org/u/{userid} (date that user added support)

Which means that recently created and possibly issues newly converted to the new project template will have a shorter version.

Three supporters required

  1. {link to user}
  2. {link to user}
  3. {link to user}

I think that change is something we can manage in individuals issues on an as needed basis.

quietone’s picture

quietone commented

I think this has fulfilled its purpose as a test run on the new project issue template and can be set to Fixed now. Any future changes can be done in a meeting, or if significant in a new issue.

This just needs someone to confirm that I did the copy/paste correctly and that the project template is the same as the template in the issue summary here.

jonathan1055’s picture

jonathan1055 commented
Status: Reviewed & tested by the community » Fixed

Thanks for doing that. Yes I confirm the new active template matches this issue summary.

I think the template really helps. I've updated a few existing issue, likewise you have, and the process seems to be working well.

I agree, no need for a mass-update to existing issues that have the shorter supporters section. New supporters might add the date, but the problem will slowly fix itself anyway.

Status: Fixed » Closed (fixed)

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