Page MenuHomePhabricator

Create a "Getting started" guide for developers
Open, MediumPublic

Description

It should cover the following:

  1. Local development environment setup
  2. How to pick tasks
  3. Coding conventions

Event Timeline

A first draft of the page is available under my user page on MediaWiki: https://www.mediawiki.org/wiki/User:APatro_(WMF)/Getting_Started_With_Translate

Will do some reviews with Niklas before marking this task as done. Additionally noticed that some pages linked from that page need to be updated.

Change 664272 had a related patch set uploaded (by Abijeet Patro; owner: Abijeet Patro):
[mediawiki/extensions/Translate@master] Update README with link to Getting started with development page

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

abi_ added a subscriber: Amire80.

We've moved the page to: https://www.mediawiki.org/wiki/Help:Extension:Translate/Getting_started_with_Translate_extension_development

Submitted a patch to add the page to the README for the Translate extension and requested @Amire80 to do a review of the documentation.

Change 664272 merged by jenkins-bot:
[mediawiki/extensions/Translate@master] Update README with link to Getting started with development page

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

Waiting on Amir to provide feedback regarding this task. Another option would be to involve Pita to also help with reviewing the documentation.

My feedback:

The installation guide with Docker and Gerrit was mostly smooth. I just have a couple of little comments about the script, which is supposed to be pasted to the command line:

  1. The # character for comments doesn't work perfectly in zsh interactive command line. I don't think it actually breaks anything, but it shows some errors. I have a Mac, and Apple deprecated bash in favor of zsh.
  2. I already had most of the extensions that the script is cloning into my extensions directory. I carefully removed these lines, but perhaps it's better to do something more automatic, for example to check that the directories don't exist already.