Page MenuHomePhabricator

Jade local dev setup / README docs
Closed, ResolvedPublic

Description

The Jade extension repo does not have a README or any sort of local development install docs.

Here is the first attempt from onboarding Kevin a couple of weeks ago:
https://etherpad.wikimedia.org/p/jade-dev

Event Timeline

ACraze renamed this task from Jade local dev/ README to Jade local dev setup / README docs.Feb 3 2020, 5:50 PM
ACraze claimed this task.
ACraze triaged this task as Low priority.
ACraze updated the task description. (Show Details)
ACraze updated the task description. (Show Details)

Change 571812 had a related patch set uploaded (by Accraze; owner: Accraze):
[mediawiki/extensions/Jade@master] add README

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

ACraze added subscribers: kevinbazira, Halfak.

@kevinbazira @Halfak, I just pushed up a patchset with a README that has local dev install docs. Let me know if you notice anything missing!

@ACraze I've reviewed your patchset and the README looks good. Just wanted to confirm though, is composer test and grunt run in the MediaWiki root or Jade root?

Change 571812 merged by jenkins-bot:
[mediawiki/extensions/Jade@master] add README

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

Change 572996 had a related patch set uploaded (by Accraze; owner: Accraze):
[mediawiki/extensions/Jade@master] update README test info T244152

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

Thanks for the review @kevinbazira, that's a good point re: composer and grunt tests. I added a new patchset with an update to the README clarifying that you should run the composer tests and grunt from the root Jade directory.

Change 572996 merged by jenkins-bot:
[mediawiki/extensions/Jade@master] update README test info T244152

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