Merge ~smoser/cloud-init:doc/hacking-cleanup into cloud-init:master

Proposed by Scott Moser
Status: Merged
Merged at revision: 0efae9c20b8230accfa96febffe6fc0ffb43a969
Proposed branch: ~smoser/cloud-init:doc/hacking-cleanup
Merge into: cloud-init:master
Diff against target: 130 lines (+56/-29)
1 file modified
HACKING.rst (+56/-29)
Reviewer Review Type Date Requested Status
cloud-init Commiters Pending
Review via email: mp+309611@code.launchpad.net

Commit message

doc: improve HACKING.rst file

Put a bit more information and a few style fixes in HACKING.rst.

To post a comment you must log in.

There was an error fetching revisions from git servers. Please try again in a few minutes. If the problem persists, contact Launchpad support.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
diff --git a/HACKING.rst b/HACKING.rst
index 63a5bde..4072d0f 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -3,28 +3,35 @@ Hacking on cloud-init
3=====================3=====================
44
5This document describes how to contribute changes to cloud-init.5This document describes how to contribute changes to cloud-init.
6It assumes you have a `Launchpad`_ account, and refers to your launchpad user
7as ``LP_USER`` throughout.
68
7Do these things once9Do these things once
8--------------------10--------------------
911
10* If you have not already, be sure to sign the CCA:12* To contribute, you must sign the Canonical `contributor license agreement`_
1113
12 - `Canonical Contributor Agreement`_14 If you have already signed it as an individual, your Launchpad user will be listed in the `contributor-agreement-canonical`_ group. Unfortunately there is no easy way to check if an organization or company you are doing work for has signed. If you are unsure or have questions, email `Scott Moser <mailto:scott.moser@canonical.com>`_ or ping smoser in ``#cloud-init`` channel via freenode.
1315
14* Clone the `LaunchPad`_ repository:16* Clone the upstream `repository`_ on Launchpad::
1517
16 git clone YOUR_USERNAME@git.launchpad.net:cloud-init18 git clone https://git.launchpad.net/cloud-init
17 cd cloud-init19 cd cloud-init
1820
19 If you would prefer a bzr style `git clone lp:cloud-init`, see21 There is more information on Launchpad as a git hosting site in
20 the `Instructions on LaunchPad`_ for more information.22 `Launchpad git documentation`_.
2123
22* Create a new remote pointing to your personal LaunchPad24* Create a new remote pointing to your personal Launchpad repository
23 repository::
2425
25 git remote add YOUR_USERNAME YOUR_USERNAME@git.launchpad.net:~YOUR_USERNAME/cloud-init26 This is equivalent to 'fork' on github::
2627
27.. _Canonical Contributor Agreement: http://www.canonical.com/contributors28 git remote add LP_USER git+ssh://LP_USER@git.launchpad.net/~LP_USER/cloud-init
29 git push LP_USER master
30
31.. _repository: https://git.launchpad.net/cloud-init
32.. _contributor license agreement: http://www.canonical.com/contributors
33.. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members
34.. _Launchpad git documentation: https://help.launchpad.net/Code/Git
2835
29Do these things for each feature or bug36Do these things for each feature or bug
30---------------------------------------37---------------------------------------
@@ -33,40 +40,60 @@ Do these things for each feature or bug
3340
34 git checkout -b my-topic-branch41 git checkout -b my-topic-branch
3542
36.. _Instructions on launchpad: https://help.launchpad.net/Code/Git
37
38* Make and commit your changes (note, you can make multiple commits,43* Make and commit your changes (note, you can make multiple commits,
39 fixes, more commits.)::44 fixes, more commits.)::
4045
41 git commit46 git commit
4247
43* Check pep8 and test, and address any issues::48* Run unit tests and lint/formatting checks with `tox`_::
4449
45 make test pep850 tox
4651
47* Push your changes to your personal LaunchPad repository::52* Push your changes to your personal Launchpad repository::
4853
49 git push -u YOUR_USERNAME my-topic-branch54 git push -u LP_USER my-topic-branch
5055
51* Use your browser to create a merge request:56* Use your browser to create a merge request:
5257
53 - Open the branch on `LaunchPad`_58 - Open the branch on Launchpad.
59
60 - You can see a web view of your repository and navigate to the branch at:
61
62 ``https://code.launchpad.net/~LP_USER/cloud-init/``
63
64 - It will typically be at:
65
66 ``https://code.launchpad.net/~LP_USER/cloud-init/+git/cloud-init/+ref/BRANCHNAME``
67
68 for example, here is larsks move-to-git branch: https://code.launchpad.net/~larsks/cloud-init/+git/cloud-init/+ref/feature/move-to-git
69
70 - Click 'Propose for merging'
71 - Select 'lp:cloud-init' as the target repository
72 - Type '``master``' as the Target reference path
73 - Click 'Propose Merge'
74 - On the next page, hit 'Set commit message' and type a git combined git style commit message like::
75
76 Activate the frobnicator.
77
78 The frobnicator was previously inactive and now runs by default.
79 This may save the world some day. Then, list the bugs you fixed
80 as footers with syntax as shown here.
81
82 The commit message should be one summary line of less than
83 74 characters followed by a blank line, and then one or more
84 paragraphs describing the change and why it was needed.
5485
55 - It will typically be at86 This is the message that will be used on the commit when it
56 ``https://code.launchpad.net/~YOUR_USERNAME/cloud-init/+git/cloud-init/+ref/BRANCHNAME``87 is sqaushed and merged into trunk.
57 for example
58 https://code.launchpad.net/~larsks/cloud-init/+git/cloud-init/+ref/feature/move-to-git
5988
60 - Click 'Propose for merging`89 LP: #1
61 - Select ``cloud-init`` as the target repository
62 - Select ``master`` as the target reference path
6390
64Then, someone on cloud-init-dev (currently `Scott Moser`_ and `Joshua91Then, someone in the `cloud-init-dev`_ group will review your changes and
65Harlow`_) will review your changes and follow up in the merge request.92follow up in the merge request.
6693
67Feel free to ping and/or join ``#cloud-init`` on freenode (irc) if you94Feel free to ping and/or join ``#cloud-init`` on freenode irc if you
68have any questions.95have any questions.
6996
97.. _tox: https://tox.readthedocs.io/en/latest/
70.. _Launchpad: https://launchpad.net98.. _Launchpad: https://launchpad.net
71.. _Scott Moser: https://launchpad.net/~smoser99.. _cloud-init-dev: https://launchpad.net/~cloud-init-dev/+members#active
72.. _Joshua Harlow: https://launchpad.net/~harlowja

Subscribers

People subscribed via source and target branches