Hello all, it’s time for the fortnightly coding standards meeting. The meeting will take place in slack in various threads
This meeting:
➤ Is for anyone interested in the Drupal coding standards.
➤ Usually happens fortnightly on Tuesday 2100 UTC. The meeting open for 24 hours to allow for all timezones.
➤ Is done on the #coding standards channel in Drupal Slack (see www.drupal.org/slack for information).
➤ Happens 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 can add to. See the parent issue for an idea of the typical agenda.
➤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.
| quietone |
There is a sniff for this. |
| quietone |
But does this need a docs change? |
| borisson_ |
I don't think it needs a doc change, the sniff should be enough? |
| Björn Brala (bbrala) |
Thats why i was thinking, IF it is not mentioned in the docs right now. |
| Björn Brala (bbrala) |
Wouldn't mind if more is dus described through the coding style checks and less though real pages, that would make the process a little easier perhaps. |
| borisson_ |
I'm not sure I understand this ^, you mean less documentation pages? |
| Björn Brala (bbrala) |
yes |
| Björn Brala (bbrala) |
But that is mostly a feeling I have. And I have not checked this feeling against the current governance rules. |
| Björn Brala (bbrala) |
(and this is kinda out of scope of this thread xD) |
| borisson_ |
haha, it sure is :smile:I think I agree, but let's open a thread for it at this (or the next) meeting to discuss this more specifically? |
| Björn Brala (bbrala) |
Yeah lets do it at next |
| Björn Brala (bbrala) |
Setting a reminder for over 13 days lol |
| Björn Brala (bbrala) |
Summarizing; Don't think we need doc change, we can coder this up, and it makes sense to do, so lets announce. |
| quietone |
Perhaps for this one we double check in accessibility that this is still the recommendation? |
| quietone |
That is, before making an announcment. |
| catch |
If help topics take over from hook_help() will this still be relevant? |
| quietone |
Good point. |
| quietone |
Checking one help topic page it looks like it is using the preferred headers. |
| quietone |
Looking at the Help text standards docs now. |
| quietone |
There is a page for Help Topic Standards. |
| quietone |
Neither of those pages is in the 'Coding Standards' part of the wiki. |
| quietone |
The module overviews in core still have the wrong headers. |
| quietone |
If hook_help is staying then this still needs work. |
| quietone |
I wonder if there should be a page for the Help standard in the Coding Standards guide? |
| urvashi_vora |
It would be good if we can include it, else the reference itself. |
| urvashi_vora |
IMHO, "cspell" seems good. |
| quietone |
All settings are prefixed with cSpell: or spell-checker:.
The docs state the above but then the examples, on the same page use both cSpell and cspell. |
| catch |
I've always assumed it was the lowercase one. |
| quietone |
lower case is easier to type. That is a plus. |
| urvashi_vora |
Indeed |
| longwave |
+1 to cspell although not sure how we can enforce this |
| quietone |
Maybe this? https://cspell.org/docs/case-sensitive/#enable-case-sensitive-checking-b... |
| quietone |
But that would cause more problems. |
| longwave |
$ grep -rq cSpell core && echo failed
failed
we could do a rudimentary check in commit-code-check.sh but that feels like a slippery slope and there should be a better way |
| longwave |
maybe we can just use flagWords in the config? not sure if that would work for the case sensitive version only though |
| quietone |
I tried flagwords and it didn't help. |
| quietone |
I added case sensitivity and while I didn't let it finish it wasn't as bad as I expected. |
Comments
Comment #5
quietone commentedComment #8
quietone commentedComment #9
quietone commentedReady for review
Comment #10
quietone commentedChange a link to use the #1234: "Mark all as read" in forums. form
Comment #11
urvashi_vora commentedEverything seems good here, I have rechecked the conversation with slack.
Comment #12
urvashi_vora commentedMarking it as Fixed.
Thanks everyone.