diff options
| -rw-r--r-- | HACKING | 49 | ||||
| -rw-r--r-- | doc/rtd/conf.py | 2 | ||||
| -rw-r--r-- | doc/rtd/index.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/moreinfo.rst | 2 |
4 files changed, 35 insertions, 20 deletions
@@ -4,30 +4,45 @@ Hacking on cloud-init To get changes into cloud-init, the process to follow is: - * If you have not already, be sure to sign the CCA: - - `Canonical Contributor Agreement`_ +* If you have not already, be sure to sign the CCA: - * Get your changes into a local bzr branch. Initialize a repo, and checkout trunk (init repo is to share bzr info across multiple checkouts, its different than git): - - ``bzr init-repo cloud-init`` - - ``bzr branch lp:cloud-init trunk.dist`` - - ``bzr branch trunk.dist my-topic-branch`` + - `Canonical Contributor Agreement`_ - * Commit your changes (note, you can make multiple commits, fixes, more commits.): - - ``bzr commit`` +* Get your changes into a local bzr branch. + Initialize a repo, and checkout trunk (init repo is to share bzr info across multiple checkouts, its different than git): - * Check pylint and pep8 and test, and address any issues: - - ``make test pylint pep8`` + - ``bzr init-repo cloud-init`` + - ``bzr branch lp:cloud-init trunk.dist`` + - ``bzr branch trunk.dist my-topic-branch`` - * Push to launchpad to a personal branch: - - ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>`` +* Commit your changes (note, you can make multiple commits, fixes, more commits.): - * Propose that for a merge into lp:cloud-init via web browser. Open the branch in `Launchpad`_, it will 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 + - ``bzr commit`` -Then, someone on cloud-init-dev (currently Scott Moser and Joshua Harlow) will review your changes and follow up in the merge request. +* Check pylint and pep8 and test, and address any issues: -Feel free to ping #cloud-init on freenode if you have any questions. + - ``make test pylint pep8`` + +* Push to launchpad to a personal branch: + + - ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>`` + +* 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. .. _Launchpad: https://launchpad.net .. _Canonical Contributor Agreement: http://www.canonical.com/contributors +.. _Scott Moser: https://launchpad.net/~smoser +.. _Joshua Harlow: https://launchpad.net/~harlowja diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py index 766f9e93..87fc40ab 100644 --- a/doc/rtd/conf.py +++ b/doc/rtd/conf.py @@ -42,7 +42,7 @@ master_doc = 'index' # |version| and |release|, also used in various other places throughout the # built documents. version = version.version_string() -# release = version +release = version # Set the default Pygments syntax highlight_language = 'python' diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index f878dbd4..53b39a31 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -24,6 +24,6 @@ Summary topics/examples topics/modules topics/moreinfo - + topics/hacking .. _Cloud-init: https://launchpad.net/cloud-init diff --git a/doc/rtd/topics/moreinfo.rst b/doc/rtd/topics/moreinfo.rst index 2e436c3c..19e96af0 100644 --- a/doc/rtd/topics/moreinfo.rst +++ b/doc/rtd/topics/moreinfo.rst @@ -3,7 +3,7 @@ More information ========= Useful external references ----------------- +------------------------- - `The beauty of cloudinit`_ - `Introduction to cloud-init`_ (video) |