update HACKING to refer to github
This commit is contained in:
parent
d90bfd6268
commit
6bf7775c36
39
HACKING.rst
39
HACKING.rst
|
@ -8,41 +8,30 @@ To get changes into cloud-init, the process to follow is:
|
||||||
|
|
||||||
- `Canonical Contributor Agreement`_
|
- `Canonical Contributor Agreement`_
|
||||||
|
|
||||||
* Get your changes into a local bzr branch.
|
* fork from github, create a branch and make your changes
|
||||||
Initialize a repo, and checkout trunk (init repo is to share bzr info across multiple checkouts, its different than git):
|
- ``git clone https://github.com/cloud-init/cloud-init.git``
|
||||||
|
- ``cd cloud-init``
|
||||||
|
- ``echo hack``
|
||||||
|
|
||||||
- ``bzr init-repo cloud-init``
|
* Check test and code formatting / lint and address any issues:
|
||||||
- ``bzr branch lp:cloud-init trunk.dist``
|
|
||||||
- ``bzr branch trunk.dist my-topic-branch``
|
|
||||||
|
|
||||||
* Commit your changes (note, you can make multiple commits, fixes, more commits.):
|
- ``tox``
|
||||||
|
|
||||||
- ``bzr commit``
|
* Commit / ammend your changes
|
||||||
|
Before review, make good commit messages with one line summary
|
||||||
|
followed by empty line followed by expanded comments.
|
||||||
|
- ``git commit``
|
||||||
|
|
||||||
* Check pep8 and test, and address any issues:
|
* Push to branch to github:
|
||||||
|
|
||||||
- ``make test pep8``
|
- ``git push``
|
||||||
|
|
||||||
* Push to launchpad to a personal branch:
|
* Make a pull request.
|
||||||
|
|
||||||
- ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>``
|
Then, someone on cloud-init team.
|
||||||
|
|
||||||
* Propose that for a merge into lp:cloud-init via web browser.
|
|
||||||
|
|
||||||
- Open the branch in `Launchpad`_
|
|
||||||
|
|
||||||
- It will typically be at ``https://code.launchpad.net/<YOUR_USERNAME>/<PROJECT>/<BRANCH_NAME>``
|
|
||||||
- ie. https://code.launchpad.net/~smoser/cloud-init/mybranch
|
|
||||||
|
|
||||||
* Click 'Propose for merging'
|
|
||||||
* Select 'lp:cloud-init' as the target branch
|
|
||||||
|
|
||||||
Then, someone on cloud-init-dev (currently `Scott Moser`_ and `Joshua Harlow`_) will
|
|
||||||
review your changes and follow up in the merge request.
|
|
||||||
|
|
||||||
Feel free to ping and/or join #cloud-init on freenode (irc) if you have any questions.
|
Feel free to ping and/or join #cloud-init on freenode (irc) if you have any questions.
|
||||||
|
|
||||||
.. _Launchpad: https://launchpad.net
|
|
||||||
.. _Canonical Contributor Agreement: http://www.canonical.com/contributors
|
.. _Canonical Contributor Agreement: http://www.canonical.com/contributors
|
||||||
.. _Scott Moser: https://launchpad.net/~smoser
|
.. _Scott Moser: https://launchpad.net/~smoser
|
||||||
.. _Joshua Harlow: https://launchpad.net/~harlowja
|
.. _Joshua Harlow: https://launchpad.net/~harlowja
|
||||||
|
|
Loading…
Reference in New Issue