summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorLars Kellogg-Stedman <lars@redhat.com>2016-07-22 15:09:24 -0400
committerScott Moser <smoser@brickies.net>2016-08-03 16:00:52 -0400
commit72d6adcb2e4cb5911f7809b89835965d4bf04476 (patch)
tree64b33f605847b5b26f67e37882442ea0c3620552 /HACKING.rst
parenteed7fccdb9e59e5b2cc9e6d94af06f075c6ced67 (diff)
downloadvyos-cloud-init-72d6adcb2e4cb5911f7809b89835965d4bf04476.tar.gz
vyos-cloud-init-72d6adcb2e4cb5911f7809b89835965d4bf04476.zip
Update build tools to work with git
- Update HACKING.rst to include git instructions - update MANIFEST.in and .gitignore to ignore git-related things - replaced tarball generation scripts with git-based script - have the spec files correctly identify themselves as cheetah templates - make brpm work with git
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst68
1 files changed, 46 insertions, 22 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 6bfe4b4d..63a5bde0 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -2,47 +2,71 @@
Hacking on cloud-init
=====================
-To get changes into cloud-init, the process to follow is:
+This document describes how to contribute changes to cloud-init.
+
+Do these things once
+--------------------
* 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):
+* Clone the `LaunchPad`_ repository:
+
+ git clone YOUR_USERNAME@git.launchpad.net:cloud-init
+ cd cloud-init
+
+ If you would prefer a bzr style `git clone lp:cloud-init`, see
+ the `Instructions on LaunchPad`_ for more information.
- - ``bzr init-repo cloud-init``
- - ``bzr branch lp:cloud-init trunk.dist``
- - ``bzr branch trunk.dist my-topic-branch``
+* Create a new remote pointing to your personal LaunchPad
+ repository::
+
+ git remote add YOUR_USERNAME YOUR_USERNAME@git.launchpad.net:~YOUR_USERNAME/cloud-init
+
+.. _Canonical Contributor Agreement: http://www.canonical.com/contributors
-* Commit your changes (note, you can make multiple commits, fixes, more commits.):
+Do these things for each feature or bug
+---------------------------------------
- - ``bzr commit``
+* Create a new topic branch for your work::
-* Check pep8 and test, and address any issues:
+ git checkout -b my-topic-branch
- - ``make test pep8``
+.. _Instructions on launchpad: https://help.launchpad.net/Code/Git
-* Push to launchpad to a personal branch:
+* Make and commit your changes (note, you can make multiple commits,
+ fixes, more commits.)::
- - ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>``
+ git commit
-* Propose that for a merge into lp:cloud-init via web browser.
+* Check pep8 and test, and address any issues::
- - Open the branch in `Launchpad`_
+ make test pep8
- - It will typically be at ``https://code.launchpad.net/<YOUR_USERNAME>/<PROJECT>/<BRANCH_NAME>``
- - ie. https://code.launchpad.net/~smoser/cloud-init/mybranch
+* Push your changes to your personal LaunchPad repository::
-* Click 'Propose for merging'
-* Select 'lp:cloud-init' as the target branch
+ git push -u YOUR_USERNAME my-topic-branch
-Then, someone on cloud-init-dev (currently `Scott Moser`_ and `Joshua Harlow`_) will
-review your changes and follow up in the merge request.
+* Use your browser to create a merge request:
-Feel free to ping and/or join #cloud-init on freenode (irc) if you have any questions.
+ - Open the branch on `LaunchPad`_
+
+ - It will typically be at
+ ``https://code.launchpad.net/~YOUR_USERNAME/cloud-init/+git/cloud-init/+ref/BRANCHNAME``
+ for example
+ https://code.launchpad.net/~larsks/cloud-init/+git/cloud-init/+ref/feature/move-to-git
+
+ - Click 'Propose for merging`
+ - Select ``cloud-init`` as the target repository
+ - Select ``master`` as the target reference path
+
+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