Page MenuHomePhabricator

Add info on how to contribute code
Closed, ResolvedPublic

Description

On https://github.com/wikimedia/pywikibot-core/pull/18, a user is pointed to "Developing pywikibot" at https://www.mediawiki.org/wiki/Manual:Pywikibot, but where should you go from there?

What would be useful to have is a page with a few straightforward points on how to contribute. Something like this:

  1. Sign up for developer access at https://www.mediawiki.org/wiki/Developer_access
  2. Read the Gerrit tutorial at https://www.mediawiki.org/wiki/Gerrit/Tutorial to learn how to set up git-review and submit patches (pull requests)
  3. Download code: git clone ssh://USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git pywikibot-core (replace USERNAME with your username)
  4. Configure git-review: git review -s
  5. Checkout a branch to work on: git checkout -b BRANCHNAME origin/master
  6. Make your changes. Remember to add tests. For info about how to run tests, see tests/README.rst
  7. Commit your changes (see the linked tutorial above for more details). When writing a commit message, please
    • prefix it with [FIX], [FEAT], [IMPR], ... (Please help me fill out this, I couldn't find an authoritative list of prefixes to use)
    • Use the last line to add a reference to the Phabricator task if one exists, e.g. Bug: T166459.
  8. Push your changes to Gerrit: git review -R

Alternatively, you can use the Gerrit Patch Uploader (https://tools.wmflabs.org/gerrit-patch-uploader/)

Event Timeline

Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript

Btw. are there style conventions/recommendations for pywikibot? If so, a link to those should also be included.

Dvorapa closed this task as Declined.EditedJul 27 2017, 1:14 PM
Dvorapa subscribed.

Everything is there, just search for it a little. But you can improve the docs on https://www.mediawiki.org/wiki/Manual:Pywikibot by yourself (as you already did). Some other useful links to start (en case they were not mentioned):

Change 368182 had a related patch set uploaded (by Danmichaelo; owner: Danmichaelo):
[pywikibot/core@master] [docs]Improve contribution section in readme

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

Dvorapa assigned this task to Danmichaelo.

Change 368182 merged by jenkins-bot:
[pywikibot/core@master] [docs]Improve contribution section in readme

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