The WikibaseLexeme.git README also includes some general Wikibase installation instructions (before the subsection about setting up WikibaseLexeme), which I think are at least partially outdated. Is updating them also part of this task?

Change 787700 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/WikibaseLexeme@master] Add submodule instructions to README.md

https://gerrit.wikimedia.org/r/787700

In T302321#7890446, @Lucas_Werkmeister_WMDE wrote:

The WikibaseLexeme.git README also includes some general Wikibase installation instructions (before the subsection about setting up WikibaseLexeme), which I think are at least partially outdated. Is updating them also part of this task?

Well, I guess the Docker part is also outdated, seeing how it links to mediawiki-docker-dev which “is deprecated, long live mwcli”…

Change 787703 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/WikibaseLexeme@master] Add New Lexeme Special Page section to README.md

https://gerrit.wikimedia.org/r/787703

Change 787700 merged by jenkins-bot:

[mediawiki/extensions/WikibaseLexeme@master] Add submodule instructions to README.md

https://gerrit.wikimedia.org/r/787700

In T302321#7890446, @Lucas_Werkmeister_WMDE wrote:

The WikibaseLexeme.git README also includes some general Wikibase installation instructions (before the subsection about setting up WikibaseLexeme), which I think are at least partially outdated. Is updating them also part of this task?

I'd say not, there is a separate task for this T306008: Update installation instructions in WikibaseLexeme.git readme file. That being said, we also need to live in the realm of reason. Is it reasonable to do in the scope of this task, for your perspective as some who is currently doing the task? If so, no task is written in stone, and could be declined.

Nah, I think we can leave it for later as long as we’re tracking it in the backlog.

Change 787703 merged by jenkins-bot:

[mediawiki/extensions/WikibaseLexeme@master] Add New Lexeme Special Page section to README.md

https://gerrit.wikimedia.org/r/787703

Verification notes:

new-lexeme-special-page.git/README.md includes...

• How: Setup development environment \o/
• How: Run development server \o/
• When and How: Linting, formatting and fixing ⇐ I would say, that it's probably worthwhile to add a section about this point and explain that even while these checks (linting + formatting) occur with the pre-commit hook, they can be run individually using the mentioned scripts (fixing is already documented though \o/).
• Where and How: Running tests (with a short description for what each type of test is for and where it goes) ⇐ There's still an explanation missing on which tests go in which directory, and how to run each type individually. I think this deserves to have it own heading in the document, for testing.

Verification Notes:

WikibaseLexeme.git/README.md includes...

• How: Setup project with submodules \o/
• When and How: Submodule update and commit workflow (npm run bump-special-new-lexeme) \o/
• When and How: Preview local changes in new-lexeme-special-page.git submodule (npm run snl:dev) \o/

Yay! \o/

I felt like listing all the different test “types” was overkill – you can see them in package.json (or just via tab completion), and I don’t think they’re that specific to this repository either. If we think this documentation is needed, I think it would be better for someone other than me to write it.

Please don't forget to add instructions for cypress-axe.

Suggested instructions:

Alternatives:

To see a summary of the violations in the console.

• npm run test:cypress

To see details about the detected violations:

1. npm run dev,
2. npm run cypress:open
3. open the console to see details about errors. (helpUrl offers info on how to fix the issue)

There is now a PR up for this: https://github.com/wmde/new-lexeme-special-page/pull/172

This should now be ready to be verified by @ItamarWMDE, I think.

Verification Notes:

new-lexeme-special-page.git/README.md includes...

• When and How: Linting, formatting and fixing \o/
• Where and How: Running tests (with a short description for what each type of test is for and where it goes) \o/

Thank you! It looks great now!