From a44ca2e095856a2401911ad72a235e6c4d598392 Mon Sep 17 00:00:00 2001 From: ctracey Date: Tue, 15 Jan 2013 11:36:56 -0500 Subject: Add a HACKING file Adding a HACKING file based upon a message from smoser on the mailing list from 12/12/2012. --- HACKING | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 HACKING (limited to 'HACKING') diff --git a/HACKING b/HACKING new file mode 100644 index 00000000..2111f7e5 --- /dev/null +++ b/HACKING @@ -0,0 +1,27 @@ +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:~/cloud-init/ + * 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/// + # 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. -- cgit v1.2.3 From 257718c8a53355c3a91bbeee95f56416c08c63bb Mon Sep 17 00:00:00 2001 From: ctracey Date: Fri, 25 Jan 2013 16:31:39 -0500 Subject: Moving HACKING to restructured text As per harlowja's suggestion, moving this HACKING file to restructured text format. --- HACKING | 56 +++++++++++++++++++++++++++++++------------------------- 1 file changed, 31 insertions(+), 25 deletions(-) (limited to 'HACKING') 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:~/cloud-init/ - * 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/// - # 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:~/cloud-init/`` + + * 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/// (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 -- cgit v1.2.3