Phabricator/Code/nl

Dit document beschrijft het ontwikkelproces van deze Wikimedia's Phabricator instantie. Phabricator is geschreven in PHP, net als like MediaWiki, dat zou het starten met het ontwikkelen moeten helpen. We kijken eerst hoe Wikimedia Phabricator gebruikt en wat we bij de ontwikkeling verwachten. Achteraf maken we dan wat opmerkingen over hoe we beginnen met de actuele ontwikkeling.



Phabricator op de Wikimedia
Wikimedia gebruikt de Phabricator met minimale aanpassingen op de upstream versie. De reden hiervoor is de grote ontwikkelingsstappen van de upstream ontwikkelaars, het onderhouden van lokale aanpassingen is lastig. De uitzonderingen zijn de extensies, die in productie in een afzonderlijke repository staan en dus regelmatig samengevoegd hoeven te worden. Alle andere wijzigingen worden dus via de upstream gedaan. Dit lijkt een beperking, maar in de praktijk reageren de upstream beheerders erg vlot op suggesties.



Wikimedia Phabricator werkschema fouten
Het is belangrijk om de levensduur van een bug te begrijpen voor aan een van de taken te beginnen. Er zijn twee projecten: #phabricator voor WMF-specifieke bugs en #phabricator-upstream voor algemene Phabricator bugs. Software bugs en uitbreidingsverzoeken vallen in de tweede categorie.

Het Phabricator-upstream werkbord toont het proces dat door taken wordt doorlopen voordat ze upstream aangemaakt worden:


 * Backlog: dit is waar standaard de taken komen te staan. Geweigerde (stalled) taken staan daar ook.
 * Need discussion: soms is een taak gebaat bij een discussie, de Wikimedianen zijn dan meer op dezelfde pagina wat dan zal zorgen voor meer en betere argumenten in het rapport / voorstel.
 * Ready to go: taken in deze kolom wachten op iemand die ze kopieert naar de upstream bug tracker.
 * Upstreamed: een taak wordt in deze kolom gezet zodra is aangegeven is dat upstream zijn.
 * Wikimedia requests: een paar verzoeken gaven aan dat iets upstream is gemaakt in naam van Wikimedia en worden dan hier voorzien van het #wikimedia tag, wij nemen aan dat deze wat meer relevant zijn.

Once a task has been upstreamed, upstream developers respond with their assessment, and suggestions for how the feature should be implemented. '' At this point a developer can start with the implementation. ''

In some cases, the upstream developers will decide a feature does not fit into their plans. In this case, the task in Wikimedia Phabricator is moved from the #phabricator-upstream project to the #phabricator project, and ends up back into the discussion stage: is this feature important enough to maintain local patches? Once this has been decided, the patch will move to 'Ready to go', and one can start with the implementation.

To prevent disappointment, please do not start with the implementation until it's clear either upstream or the WMF maintainers will accept your patch.

How fast a task is reported upstream may depend of how uncontroversial is (going through the Need Discussion column) and how high is its priority, but it ultimately depends on who takes the time to report it upstream. This is an opt-in process aimed to check the appropriateness and relevance of a task before being created upstream. Anyone with permissions in upstream can create tasks upstream bypassing this process, however, before submitting an upstream task, please read Introduction to contributing to Phabricator, Arcanist and libphutil.



Lokale aanpassingen
As mentioned in the previous section, we try to keep local patches to a minimum. There are limited resources available to maintain patches, and to merge them with changes from upstream. Any local patches therefore have to be discussed within the #phabricator project. It's significantly less work to maintain a phabricator extension, as long as care is taken in avoiding the use of particularly new / unstable APIs from phabricator's core. Although extensions don't require merging and potential code conflicts, they do require testing each time we pull in upstream changes. Phabricator does not have any frozen APIs which are deemed safe to depend on. At this time we have virtually no modifications to the phabricator core, except for changing the favicon.ico to use Wikimedia colors.

The current code of the Wikimedia Phabricator instance itself:


 * phabricator/phabricator
 * phabricator/arcanist
 * phabricator/libphutil

The current locally-maintained extensions are:


 * Several customizations in one code repository, such as the MediaWiki OAuth extension (not upstreamed; see the Differential revisions and commits at https://secure.phabricator.com/T5096), Security related code, the MediaWiki Userpage field on Phabricator user pages, etc.



Website configuratie
Most of the configuration is set through the web interface. Defaults (shared between https://phabricator.wikimedia.org and e.g. https://phab.wmflabs.org) are set using the puppet maniphest.



Instellen
The easiest way to get set up is by using MediaWiki-Vagrant using the 'phabricator' role. Follow the steps on MediaWiki-Vagrant to install MediaWiki-Vagrant, then enable the phabricator role using

http://phabricator.local.wmftest.net:8080/
 * Access the Phabricator instance at URL:
 * The Phabricator install is located in `/srv/phabricator/` (?) on the VM. To edit and submit a patch:

Congratulations, you have submitted your first patch!



Cloud VPS VM gebruiken
If you know how to spin up a VM on Cloud VPS, and have the rights to do so, you can create an instance with the `phabricator::labs` role. This should give you a basic setup with the same configuration as https://phab.wmflabs.org.



Migratie code van Bugzilla, RT, Mingle, Trello naar Phabricator
The scripts that Wikimedia used for migrating its Bugzilla and RT data to Phabricator are available. Note that the migration code is not bug-free and that it was only written and used for the specific configurations of Wikimedia's tools. Also note other migration scripts, e.g. the GStreamer project used a phill script by Emanuele Aina to import their data from Bugzilla into Phabricator in 2015.

Data was migrated from Mingle to Phabricator via a script available in P129.

The scripts to migrate data from Trello to Phabricator are available. See T821 for more information.