Hello all, it’s time for the fortnightly coding standards meeting.

This meeting:
➤ Is for anyone interested in the Drupal coding standards.
➤ Is held on the #coding standards channel in Drupal Slack (see www.drupal.org/slack for information).
➤ Usually happens fortnightly. Alternating between Tuesday 2100 UTC and Wednesday 0900 UTC.
➤ The meeting open for 24 hours to allow for all time zones.
➤ Discussion is done in threads, which you can follow to be notified of new replies even if you don’t comment in the thread. You may also join the meeting later and participate asynchronously.
➤ Has a public agenda anyone by adding a comment to the meeting issue.
➤ A transcript will be made using drupal-meeting-parser and posted to the agenda issue. For anonymous comments, start with a :bust_in_silhouette: emoji. To take a comment or thread off the record, start with a :no_entry_sign: emoji.
➤ The transcript will include comments made during the 24 hours of the meeting. However, comments made after the 24 hours may not be in transcript.

Current ping list: @catch, @larowlan, @longwave, @quietone
@dww, @borisson_ @longwave @Björn Brala, @Aaron McHale, @Alex Skrypnyk, @Urvashi, @Kingdutch

0️⃣ Who is here today? Comment in the thread to introduce yourself. We’ll keep the meeting open for 24 hours to allow for all time zones.

kimb0 Kim :flag-au:
quietone Kia ora!
longwave :wave:
Björn Brala (bbrala) Ello

1️⃣ What topics do you want to discuss? Post in this thread and we’ll open threads for them as appropriate.

quietone #3443092: [2024-05-15] Prepare blogpost for annoucement/updates

2️⃣ Action items

2️⃣.1️⃣ Approve minutes for previous meeting(s)

larowlan Very old one #3424784: Coding Standards Meeting Wednesday 2024-03-13 0900 UTC where we missed the meeting - marked as fixed (edited)

2️⃣.2️⃣ TBD

3️⃣ Fixed since last meeting

4️⃣ RTBC issues

4️⃣ .1️⃣ #3339746: Coding style for PHP Enumerations

larowlan I think the next step here is core committers meeting cc @pameeela
Björn Brala (bbrala) seems so yeh

4️⃣.2️⃣ #3324368: Update CSS coding standards to include PostCSS and Drupal 10

larowlan Still needs someone to champion updating the docs
quietone I have blocked out time this week to get on to this.
larowlan I feel like this should be the responsibility of those championing the changes
larowlan The coding standards committee is responsible for the process and the decision but not necessarily the work
larowlan Unless this is something you have an interest in of course 🙂
quietone True. I will keep that in mind.
quietone I've identified one section of googledoc, 'Formatting CSS in Drupal Core'  that will be easy to replace the existing page with. I might have time tomorrow to work on that.

5️⃣ New Issues

5️⃣.1️⃣ ...

6️⃣ Old issues (edited) 

6️⃣.1️⃣ #2563453: Follow DOXYGEN syntax for how @addtogroup is supposed to work

larowlan I think this probably doesn't need to be in the coding standards queue. If there are docs in core that are wrong, they should have core issues and be fixed like any other bug
quietone I am not sure about that.  The first comment, says that is should be a CS issue first. (edited)
quietone How to use '@addtogroup' is defined in the coding standards, so I think we need to decide if that is correct or needs to be changed or just needs clarification.  https://www.drupal.org/docs/develop/standards/php/api-documentation-and-... (edited)
quietone I don't understand the problem yet. Even when referring to these examples, https://internal.dunescience.org/doxygen/group_8cpp_source.html
quietone It seems to me that core and api.drupal.org is using the same style as the example.
quietone What am I missing?
quietone This issue doesn't really explain to me what is wrong the core docs and how they should be fixed.
larowlan PMNMI?
quietone That's a good idea, assuming that no one else has a better idea after the 24 hours of the meeting.
Björn Brala (bbrala) Wish i had something to add here. Sorry

6️⃣.2️⃣ #2530752: Ban contractions in code documentation

larowlan I wonder if 'plain english' has a take on this. As a native speaker I would defer to non-native speakers for their thoughts on this. But contractions aren't unique to English
quietone I found these linkshttps://www.plainlanguage.gov/guidelines/conversational/use-contractions...
quietone I get that we should avoid negative contractions (3rd link).  But use contractions if you would say it in a conversation out load (2nd link). In the same article (2nd link) they give an example with a contraction and without and state that the second one is better.
quietone I am going to post in #multilingual for opinions on this.
quietone The motivation in the IS was for professionalism whereas I think our community prefers informal and friendly but not at the cost of easy to understand language.
quietone I update the IS with the template so the above links are on the issue and so is a link to the d.o. coding standards docs for this.
quietone Link for #multilingual discussion, https://drupal.slack.com/archives/C55J600UX/p1716351528932729
borisson_ If we never use any contractions it sounds very formal to me. We always prefer natural and friendly language, which is why we never use the MUST, SHOULD language that psr uses. (non native speaker)
borisson_ I think we shouldn't ban them

6️⃣.3️⃣ #1220000: Standard: Use of "We" and "I" in comments in code

larowlan I don't feel strongly about this other than that we shouldn't use gendered pronouns
quietone Definitely use 'we' over 'I'. But then I try to write docs that don't require a pronoun.
quietone I was grepping for instances of 'I' and there aren't many, so that is good. (edited)
quietone Added template because adding an item about gendered pronouns is worth discussing.
Björn Brala (bbrala) i tend to 'we' also, mostly cause of the air of collaboration, and no decision is ever done by an 'i' in the end.

6️⃣.4️⃣ #2480417: Introduce standard documentation for event subscriber methods

larowlan I think this is a won't fix. The event class should be enough. What do others think? (edited)
longwave agree, this dates back to when we used constants for event names, class names are preferred now (although changing everything already in use is a different matter)
quietone I agree to the above

6️⃣.5️⃣ #2336101: Add @property statements to FieldType classes for better IDE completion

larowlan This feels worth doing. Phpstan drupal is shipping stubs to add these but it would make more sense if they lived on the actual classes. cc @mglaman
larowlan Next step here is to update issue summary to match new format
longwave +1 to doing this in core
quietone And we need to make sure that api.drupal.org can handle the tag.
mglaman Yaaas. It'd be great to have all of the stubs in phpstan-drupal upstream
mglaman Including the generics
quietone Converted to using the new template.
Björn Brala (bbrala) I know a few colleagues (and i) who would be very very very very happy if we start documenting those (and indeed generics ;p) (edited)

7️⃣ JS Coding standards are out of date (var is not good practice) https://drupal.slack.com/archives/C02LJCF78E8/p1715591647872509

larowlan The eslint rules already enforced this so the docs page has been updated, thanks @sanzante

8️⃣ #3443092: [2024-05-15] Prepare blogpost for annoucement/updates

larowlan +1 for posting this
quietone Adding here to help me remember!
quietone I've updated the announcement to add correct dates. And I added reference to the change records.
quietone Unfortunately, I can't post it. My permission has been removed and I don't know why that would be. I have left a message in #drupalorg
quietone Thanks to @larowlan bookmarking the 'add post link' and I had access to that this is now published.
quietone https://www.drupal.org/about/core/blog/coding-standards-proposals-for-fi...

9️⃣ Add to project page and blog posts that the changes are announced in change records (edited) 

quietone Something like ' Changes to the Drupal Coding Standards are announced via Coding Standards change notices.' And linked to the published CRs.

Participants:

larowlan, bbrala, quietone, borisson_, longwave, mglaman

Comments

quietone created an issue. See original summary.

quietone credited bbrala.

quietone credited larowlan.

quietone credited longwave.

quietone credited mglaman.

quietone’s picture

Issue summary: View changes
quietone’s picture

Status: Active » Needs review
bbrala’s picture

Status: Needs review » Reviewed & tested by the community

All good. Seems this is complete.

urvashi_vora’s picture

Status: Reviewed & tested by the community » Fixed

Marking it fixed.

Status: Fixed » Closed (fixed)

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