Feature summary (what you would like to be able to do and where):
Make the platform more legible and accessible for technical contributors who will write edit checks and suggestions in the future.
Benefits:
- Technical contributors can easily start new checks and offer patches to existing ones.
What does done look like?
- A brief overview of TextMatchEditCheck, in case the user can be directed there instead
- A minimal VE + Editcheck dev setup guide for mwcli – eg a pointer to other documentation and LocalSettings.php changes.
- One or two examples
- Lifecycle documentation
- What listeners exist, when they fire, what data they receive
- What context data is available, eg action tags (dismissal etc), modified ranges, selection
- Brief guide to working in the codebase
- Pointers to VE data model concepts and a brief overview
- Examples of how to do the following with the data model:
- Search for strings (modified or otherwise)
- Identify modified nodes
- Identify nodes of a particular type
- Notes on enabling checks for development
- Pointers to the edit check configuration file and how it's laid out
- It's clear how to test a check, eg, enabling experimental checks and suggestions
Timeframe
I'll seek feedback on this as I tend to underestimate how long it takes me to write text. I think it would be reasonable to target 8 hours, expecting some of the items above to be half an hour and some to be 1.5-2 hours. Generating examples feels harder to scope, I'll aim to outline one full example and the interesting bits of a second one, based on existing code.