Add additional git, npm and composer workflow documentation to WikibaseLexeme.git readme
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

Currently there are a few workflows used in the development of WikibaseLaxeme that remain undocumented, these include: linting & codesniffing, producing static assests for local development, and running unit / integration tests. In order to allow for clear and transparent workflow process and ease onboarding to the codebase, running instructions for these should be included in the README or in a dedicated Development instructions markdown file linked from the main readme.

Acceptance Criteria:

Developer documentation includes:

Updating local npm and composer dependencies
Updating submodules
Producing static assests for local development
Linting / codesniffing instructions
Improve Unit / integration test running instructions

Details

	Subject	Repo	Branch	Lines +/-
	Rework dev setup and test documentation in README	mediawiki/extensions/WikibaseLexeme	master	+139 -108

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		ItamarWMDE	T302324 [EPIC] Refresh WikibaseLexeme readme file
		Resolved		noarave	T306010 Add additional git, npm and composer workflow documentation to WikibaseLexeme.git readme

Event Timeline

ItamarWMDE created this task.Apr 13 2022, 9:19 AM

ItamarWMDE mentioned this in T302324: [EPIC] Refresh WikibaseLexeme readme file.

ItamarWMDE moved this task from Radar to Radar on the User-ItamarWMDE board.Apr 13 2022, 10:06 AM

ItamarWMDE moved this task from Backlog to Tech backlog on the Special:NewLexeme revival board.Apr 13 2022, 10:08 AM

Prio Notes:

Does not affect end users
Allows current developers to be reminded of common workflows in the repository → Affects development efforts
Does not affect known process owners
Assists with the onboarding of future developers into this project as maintainers → Affects onboarding efforts, external developers

karapayneWMDE updated the task description. (Show Details)May 3 2022, 10:18 AM

karapayneWMDE updated the task description. (Show Details)

karapayneWMDE set the point value for this task to 5.

karapayneWMDE moved this task from Tech backlog to Special:NewLexeme revival - sprint 9 on the Special:NewLexeme revival board.May 31 2022, 9:01 AM

karapayneWMDE edited projects, added Special:NewLexeme revival (Special:NewLexeme revival - sprint 9); removed Special:NewLexeme revival.

ItamarWMDE moved this task from To Do to Parents / Waiting on the Special:NewLexeme revival (Special:NewLexeme revival - sprint 9) board.Jun 1 2022, 8:25 AM

ItamarWMDE updated the task description. (Show Details)Jun 1 2022, 9:00 AM

Task Breakdown Notes:

The updating submodules and dependencies ACs are really about day-to-day dev workflows, and can be included in their own sections
While some unit and integration test instructions are included, they could be reworked a bit to resemble the instructions on new-lexeme-special-page.git
As the text in the main README file is getting quite long, we might want to consider splitting the developer guide into a new file and linking to it from the main README
We could also potentially add a TOC generator like DocToc to ensure easy navigation of the page

See the following developer guides for reference: