[prev in list] [next in list] [prev in thread] [next in thread]
List: wikitech-l
Subject: [Wikitech-l] Re: Best practices for extensions
From: Krinkle <krinkle () fastmail ! com>
Date: 2022-03-14 19:01:08
Message-ID: c53376ed-39bd-4d23-ae1f-8c0dd7b355c9 () www ! fastmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
Thanks everyone for sharing thoughts here and on the talk page \
<https://www.mediawiki.org/wiki/Talk:Best_practices_for_extensions>.
A number of clarifications have been made, and some unready/outdated sections have \
for the time being been removed, shortened or replaced with a non-nominal reference \
to a different page (such as Accessibility).
To the best of my knowledge, the remaining points of this best practices guide are \
now reflective of the practices that most MediaWiki extension maintainers have been \
practicing in recent years (both in WMF-deployed extensions and many third-party \
extensions alike). As such, I've marked it as a developer guideline.
There are open discussion topics on the talk page \
<https://www.mediawiki.org/wiki/Talk:Best_practices_for_extensions> about more \
practices to add, including a topic about Accessibility guidelines \
<https://www.mediawiki.org/wiki/Topic:Wqvqvhgsvpu1je15> (Do we re-incorporate some of \
it? And how? How much do we duplicate? If not, what should we do instead?)
-- Timo
On Thu, 27 Jan 2022, at 04:43, Krinkle wrote:
> Hi all,
>
> You may be familiar with the Best practices for extensions \
> <https://www.mediawiki.org/wiki/Best_practices_for_extensions> page on \
> mediawiki.org. It has been marked as a draft since 2017.
> I'd like to polish this page and get it to a state where it would be \
> uncontroversial to label it as "Development guideline \
> <https://www.mediawiki.org/wiki/Development_guidelines>". This would not make it a \
> hard policy. Neither does it imply that it covers all practices in all situations.
> Rather, it would mean that the items that are there now are indeed a part of our \
> current best practices. We would keep it alive through bold \
> <https://en.wikipedia.org/wiki/Wikipedia:Be_bold> edits and talk page \
> conversations, similar to our Coding conventions \
> <https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP> and other such \
> guidelines that we maintain peer to peer and through consensus.
> The reason I've not simply labelled it as such already is because before today I \
> found the document to be out of sync with our actual practices. I have made a \
> number of changes with descriptive edit summaries to bring it in sync with what I \
> percieve to be our best practices; based on how myself and other maintainers \
> perform code review at large, and how we review new extensions prior to deployment. \
> All are welcome to fix mistakes, raise questions/concerns on the talk page, on \
> this thread. You're also welcome to message me directly anytime if you prefer.
[Attachment #5 (text/html)]
<!DOCTYPE html><html><head><title></title><style type="text/css">
p.MsoNormal,p.MsoNoSpacing{margin:0}</style></head><body><div>Thanks everyone for \
sharing thoughts here and on the <a \
href="https://www.mediawiki.org/wiki/Talk:Best_practices_for_extensions">talk \
page</a>.<br></div><div><br></div><div>A number of clarifications have been made, and \
some unready/outdated sections have for the time being been removed, shortened or \
replaced with a non-nominal reference to a different page (such as \
Accessibility).<br></div><div><br></div><div>To the best of my knowledge, the \
remaining points of this best practices guide are now reflective of the practices \
that most MediaWiki extension maintainers have been practicing in recent years (both \
in WMF-deployed extensions and many third-party extensions alike). As such, I've \
marked it as a developer guideline.<br></div><div><br></div><div>There are open \
discussion topics on the <a \
href="https://www.mediawiki.org/wiki/Talk:Best_practices_for_extensions">talk \
page</a> about more practices to add, including <a \
href="https://www.mediawiki.org/wiki/Topic:Wqvqvhgsvpu1je15">a topic \
about Accessibility guidelines</a> (Do we re-incorporate some of it? And how? \
How much do we duplicate? If not, what should we do \
instead?)<br></div><div><br></div><div>-- Timo<br></div><div><br></div><div>On Thu, \
27 Jan 2022, at 04:43, Krinkle wrote:<br></div><blockquote type="cite" id="qt" \
style=""><div>Hi all,<br></div><div><br></div><div>You may be familiar with the <a \
href="https://www.mediawiki.org/wiki/Best_practices_for_extensions">Best practices \
for extensions</a> page on mediawiki.org. It has been marked as a draft since \
2017.<br></div><div><br></div><div>I'd like to polish this page and get it to a state \
where it would be uncontroversial to label it as "<a \
href="https://www.mediawiki.org/wiki/Development_guidelines">Development \
guideline</a>". This would not make it a hard policy. Neither does it imply that it \
covers all practices in all situations.<br></div><div><br></div><div>Rather, it would \
mean that the items that are there now are indeed a part of our current best \
practices. We would keep it alive through <a \
href="https://en.wikipedia.org/wiki/Wikipedia:Be_bold">bold</a> edits and talk page \
conversations, similar to our <a \
href="https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP">Coding \
conventions</a> and other such guidelines that we maintain peer to peer and through \
consensus.<br></div><div><br></div><div>The reason I've not simply labelled it as \
such already is because before today I found the document to be out of sync with our \
actual practices. I have made a number of changes with descriptive edit summaries to \
bring it in sync with what I percieve to be our best practices; based on how myself \
and other maintainers perform code review at large, and how we review new extensions \
prior to deployment.<br></div><div><br></div><div>All are welcome to fix mistakes, \
raise questions/concerns on the talk page, on this thread. You're also welcome to \
message me directly anytime if you \
prefer.<br></div></blockquote><div><br></div></body></html>
_______________________________________________
Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org
To unsubscribe send an email to wikitech-l-leave@lists.wikimedia.org
https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic