Skip to content
Snippets Groups Projects
Commit f6542147 authored by Adam Williamson's avatar Adam Williamson Committed by Adam Williamson
Browse files

Update development docs with a more convenient workflow


It's much nicer to have the main repo as origin and your fork as
another remote you just push PR branches to. That way you don't
have to deal with resyncing the master branch of your fork all
the time.

Signed-off-by: default avatarAdam Williamson <awilliam@redhat.com>
parent 81f5533c
No related branches found
No related tags found
No related merge requests found
......@@ -12,12 +12,14 @@ Development environment
If you plan to submit a pull request, you should first
`fork <https://github.com/mwclient/mwclient#fork-destination-box>`_
the mwclient repo on GitHub, then clone your own fork:
the mwclient repo on GitHub, then check out the original repository
and configure your fork as a remote:
.. code:: bash
$ git clone git@github.com:MYUSERNAME/mwclient.git
$ git clone https://github.com/mwclient/mwclient.git
$ cd mwclient
$ git remote add fork git@github.com:MYUSERNAME/mwclient.git
You can then use pip to do an "editable" install so that your
edits will be immediately available for (both interactive
......@@ -27,6 +29,12 @@ and automated) testing:
$ pip install -e .
Create a new branch for your changes:
.. code:: bash
$ git checkout -b my-branch
Test suite
----------
......@@ -91,7 +99,13 @@ on the main master branch to ease merging:
.. code:: bash
$ git remote add upstream https://github.com/mwclient/mwclient.git
$ git rebase upstream master
$ git rebase master
When it is ready, push your branch to your remote:
.. code:: bash
$ git push -u fork my-branch
Then push your code and open a pull request on GitHub.
Then you can open a pull request on GitHub. You should see a URL to do this
when you push your branch.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment