Jump to content

Topic on Talk:Best practices for extensions

Align language to RFC 2119?

12
Summary by Thiemo Kreuz (WMDE)

Done.

Jdforrester (WMF) (talkcontribs)

Right now this document uses language similar to but different from RFC 2119:

  • REQUIRED – Meeting these criteria likely means your extension will work, but it may not be sustainable or maintainable.
  • SHOULD – Meeting these criteria likely means your extension works well and will continue to work well in the future
  • GOLD – Meeting these criteria means your extension is the ideal standard we all aspire to be, and should be used as an example to other developers

It might be better to directly use that RFC's language, e.g.:

  • MUST – Meeting these criteria likely means your extension will work, but it may not be sustainable or maintainable.
  • SHOULD – Meeting these criteria likely means your extension works well and will continue to work well in the future.
  • RECOMMENDED – Meeting these criteria means your extension is the ideal standard we all aspire to be, and should be used as an example to other developers.

Thoughts?

BDavis (WMF) (talkcontribs)

+1 from me for using the RFC 2119 labels.

Jdforrester (WMF) (talkcontribs)
Quiddity (WMF) (talkcontribs)

+1 from me.

SamanthaNguyen (talkcontribs)

I support this change, makes sense to me.

Samwilson (talkcontribs)

Good idea. I been feeling like the 'GOLD' left a bit of room for "oh let's not bother", which RECOMMENDED doesn't so much. :)

Mainframe98 (talkcontribs)

Absolutely +1.

Tgr (WMF) (talkcontribs)

RFC 2119 does not differentiate between SHOULD and RECOMMENDED; the levels are MUST, SHOULD and MAY (but the last one doesn't really match what GOLD means).

Jdforrester (WMF) (talkcontribs)

Yeah, I'm being a bit cheeky in seeing a distinction between SHOULD and RECOMMENDED which formally isn't there.

Trizek (WMF) (talkcontribs)

Go for Must, Should and Recommended while they are (I think) quite universally understood.

Jdforrester (WMF) (talkcontribs)
Samwilson (talkcontribs)

thanks looks good!