blob: 9c67ca79cc6f4bf3a40365a92c442ec3d5cd82dd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
============
Contributing
============
Contributions are most welcome! You must first create a
Launchpad account and `follow the instructions here <https://docs.openstack.org/infra/manual/developers.html#account-setup>`_
to get started as a new OpenStack contributor.
Once you've signed the contributor license agreement and read through
the above documentation, add your public SSH key under the 'SSH Public Keys'
section of review.openstack.org_.
.. _review.openstack.org: https://review.openstack.org/#/settings/
You can view your public key using:
::
$ cat ~/.ssh/id_*.pub
Set your username and email for review.openstack.org:
::
$ git config --global user.email "example@example.com"
$ git config --global user.name "example"
$ git config --global --add gitreview.username "example"
Next, Clone the github repository:
::
$ git clone https://github.com/openstack/cyborg.git
You need to have git-review in order to be able to submit patches using
the gerrit code review system. You can install it using:
::
$ sudo yum install git-review
To set up your cloned repository to work with OpenStack Gerrit
::
$ git review -s
It's useful to create a branch to do your work, name it something
related to the change you'd like to introduce.
::
$ cd cyborg
$ git branch my_special_enhancement
$ git checkout !$
Make your changes and then commit them using the instructions
below.
::
$ git add /path/to/files/changed
$ git commit
Use a descriptive commit title followed by an empty space.
You should type a small justification of what you are
changing and why.
Now you're ready to submit your changes for review:
::
$ git review
If you want to make another patchset from the same commit you can
use the amend feature after further modification and saving.
::
$ git add /path/to/files/changed
$ git commit --amend
$ git review
If you want to submit a new patchset from a different location
(perhaps on a different machine or computer for example) you can
clone the Cyborg repo again (if it doesn't already exist) and then
use git review against your unique Change-ID:
::
$ git review -d Change-Id
Change-Id is the change id number as seen in Gerrit and will be
generated after your first successful submission.
The above command downloads your patch onto a separate branch. You might
need to rebase your local branch with remote master before running it to
avoid merge conflicts when you resubmit the edited patch. To avoid this
go back to a "safe" commit using:
::
$ git reset --hard commit-number
Then,
::
$ git fetch origin
::
$ git rebase origin/master
Make the changes on the branch that was setup by using the git review -d
(the name of the branch is along the lines of
review/username/branch_name/patchsetnumber).
Add the files to git and commit your changes using,
::
$ git commit --amend
You can edit your commit message as well in the prompt shown upon
executing above command.
Finally, push the patch for review using,
::
$ git review
Adding functionality
--------------------
If you are adding new functionality to Cyborg please add testing for that functionality
and provide a detailed commit message outlining the goals of your commit and how you
achived them.
If the functionality you wish to add doesn't fix in an existing part of the Cyborg
achitecture diagram drop by our team meetings to disscuss how it could be implemented
|
