Page MenuHomePhabricator

Update documentation of Reading Web contribution process
Closed, DuplicatePublic



We don't really document our process for making contributions very well. We have sections in that explain tests and commits, but some aren't especially well-written. As an example, I tried following the instructions for running tests [on MobileFrontend] and was immediately met with an error and nowhere to go for troubleshooting (if I were a first-time volunteer who didn't know about #wikimedia-mobile on IRC). In order to help onboard new devs and encourage volunteer contributions, I think we should refactor the top of to be a bit more "how-to", or have another document in the repo to describe how to get started. If we decide on a new document I'd recommend or CONTRIBUTIONS.mediawiki, the latter of which could correspond to a page on

As AC, the following statement should be true:
As a new contributor with only a fresh vagrant instance and a gerrit account, I should be able to follow the steps in (or to drive a change from start to finish, including running tests.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 18 2016, 4:29 PM
jhobs renamed this task from Update documentation of contribution process to Update documentation of Reading Web contribution process.Aug 18 2016, 4:47 PM
jhobs triaged this task as Medium priority.Aug 18 2016, 5:17 PM
jhobs moved this task from Incoming to Triaged but Future on the Readers-Web-Backlog board.
Jdlrobson assigned this task to pmiazga.Apr 13 2017, 5:30 PM
Jdlrobson added subscribers: pmiazga, Jdlrobson.

Seems pretty clear to me. @pmiazga as the newbie to the team can you flesh out any ways we can improve?
Isn't concise enough?