Contrib.social

Revise coding standards to use IETF RFC 2119 standards

Open on Drupal.org →
Created on 26 September 2012, over 12 years ago
Updated 6 February 2024, about 1 year ago

Problem/Motivation

Our coding standards are out of sync with the standard way technical docs are written, which is to conform to RFC 2119: http://www.ietf.org/rfc/rfc2119.txt

We SHOULD revise our language to conform to that terminology, for consistency and clarity.

Split off from: #1791872-49: [Policy, no patch] Add special tag to identify issues ready for a high level only review →

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}

Add current text in blockquotes

Add proposed text in blockquotes

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

Remaining tasks

  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 →

✨ Feature request
Status

Closed: won't fix

Component

Documentation

Created by

🇺🇸United States cweagans Boise, ID, USA

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment over 1 year ago →
    🇳🇿New Zealand quietone

    This comment → from @pfrenssen, provides background that the Drupal standards are deliberately written in a friendly style and avoids using the all caps.

    Since I was here I converted to the new project issue template.

  • Comment about 1 year ago →
    🇳🇿New Zealand quietone

    I have been thinking more about this and based on #13 I think this is a won't fix.

  • Comment about 1 year ago →
    🇳🇿New Zealand quietone

    This was discussed at a coding standards meeting, discussion '%'. #3414201: Coding Standards Meeting Tuesday 30 January 2024 21:00 UTC → . Three committee members replied that they support won't fix.

  • Status changed to Closed: won't fix about 1 year ago
  • Comment about 1 year ago →
    🇺🇸United States dww

    Yeah, 3 core committers all opposed this (@quietone, @catch, @larowlan). I'm also now on the CS committee and do NOT think we SHOULD change our standards to begin SHOUTING, even though EVERYONE else does it. 😅

    The CS process has changed a lot over the years since this issue was opened. If anyone strongly wants to revisit this, please open a new issue about it and try to get new supporters, but given how many of the current committers and committee members oppose it, I doubt it's going to happen.

    Thanks,
    -Derek

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024