summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorctracey <ctracey@craigtracey.com>2013-01-25 16:31:39 -0500
committerctracey <ctracey@craigtracey.com>2013-01-25 16:31:39 -0500
commit257718c8a53355c3a91bbeee95f56416c08c63bb (patch)
tree8f3b77f3da519f0995025d890f9a29ab4f25bf3e
parenta44ca2e095856a2401911ad72a235e6c4d598392 (diff)
downloadvyos-cloud-init-257718c8a53355c3a91bbeee95f56416c08c63bb.tar.gz
vyos-cloud-init-257718c8a53355c3a91bbeee95f56416c08c63bb.zip
Moving HACKING to restructured text
As per harlowja's suggestion, moving this HACKING file to restructured text format.
-rw-r--r--HACKING56
1 files changed, 31 insertions, 25 deletions
diff --git a/HACKING b/HACKING
index 2111f7e5..433738da 100644
--- a/HACKING
+++ b/HACKING
@@ -1,27 +1,33 @@
+=====================
+Hacking on cloud-init
+=====================
+
To get changes into cloud-init, the process to follow is:
- * get your changes into a local bzr branch:
- # init 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
- * commit your changes
- bzr commit
- # note, you can make multiple commits, fixes, more commits.
- * check pylint and pep8 and test , and address issues
- 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 be at:
- # https://code.launchpad.net/<YOUR_USERNAME>/<PROJECT>/<BRANCH_NAME>
- # for example:
- # 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 #cloud-init on freenode if you have any questions.
+ * If you have not already, be sure to sign the CCA:
+ - `Canonical Contributor Agreement`_
+
+ * 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``
+
+ * Commit your changes (note, you can make multiple commits, fixes, more commits.):
+ - ``bzr commit``
+
+ * Check pylint and pep8 and test, and address any issues:
+ - ``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 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 #cloud-init on freenode if you have any questions.
+
+.. _Launchpad: https://launchpad.net
+.. _Canonical Contributor Agreement: http://www.canonical.com/contributors