You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/Contributor-Guide.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,6 +131,37 @@ git commit
131
131
git push
132
132
```
133
133
134
+
## Hotfix Workflow
135
+
136
+
When an OpenMPF project administrator determines that a code change is urgently needed to fix a bug in previously released code, the pull request workflow is modified in the following ways.
137
+
138
+
- Create your feature branch off of the master branch, not develop. The convention is to include the prefix "hotfix/" in the name of the branch.
139
+
- When creating your pull request on the web page for the repo you are modifying, leave the 'base:master' dropdown menu as is, and change the 'compare:' dropdown to the name of your hotfix branch.
140
+
- After the PR has been reviewed and accepted, land the PR as described above.
141
+
- Next, create a new branch off of the develop branch. The convention is to use the prefix "hf-merge/" in the name of the branch.
142
+
- Merge the master branch into your hf-merge branch.
143
+
```
144
+
git checkout master
145
+
git pull
146
+
git checkout develop
147
+
git pull
148
+
git checkout -b hf-merge/<branch-name>
149
+
git merge master
150
+
git push -u
151
+
```
152
+
- Create a pull request for this branch as described above in the Contributor Instructions, using develop as the 'base:' branch, and your hf-merge branch as the 'compare:' branch.
153
+
- The remainder of the process for reviewing and landing a PR to the develop branch must be followed at this point, with one exception. You should merge your branch to the develop branch on the command line, instead of through the GitHub UI, to preserve commits and not squash them into one.
154
+
```
155
+
git checkout develop
156
+
git pull
157
+
git merge hf-merge/<branch-name>
158
+
```
159
+
Make sure that the merge is a fast-forward merge.
160
+
```
161
+
git push
162
+
```
163
+
164
+
134
165
# Versioning a New Release
135
166
136
167
The decision to version a new release is based on the following factors:
<p>When an OpenMPF project administrator determines that a code change is urgently needed to fix a bug in previously released code, the pull request workflow is modified in the following ways.</p>
447
+
<ul>
448
+
<li>Create your feature branch off of the master branch, not develop. The convention is to include the prefix "hotfix/" in the name of the branch.</li>
449
+
<li>When creating your pull request on the web page for the repo you are modifying, leave the 'base:master' dropdown menu as is, and change the 'compare:' dropdown to the name of your hotfix branch.</li>
450
+
<li>After the PR has been reviewed and accepted, land the PR as described above.</li>
451
+
<li>Next, create a new branch off of the develop branch. The convention is to use the prefix "hf-merge/" in the name of the branch.</li>
452
+
<li>Merge the master branch into your hf-merge branch.</li>
453
+
</ul>
454
+
<pre><code>git checkout master
455
+
git pull
456
+
git checkout develop
457
+
git pull
458
+
git checkout -b hf-merge/<branch-name>
459
+
git merge master
460
+
git push -u
461
+
</code></pre>
462
+
463
+
<ul>
464
+
<li>Create a pull request for this branch as described above in the Contributor Instructions, using develop as the 'base:' branch, and your hf-merge branch as the 'compare:' branch.</li>
465
+
<li>The remainder of the process for reviewing and landing a PR to the develop branch must be followed at this point, with one exception. You should merge your branch to the develop branch on the command line, instead of through the GitHub UI, to preserve commits and not squash them into one.</li>
466
+
</ul>
467
+
<pre><code>git checkout develop
468
+
git pull
469
+
git merge hf-merge/<branch-name>
470
+
</code></pre>
471
+
472
+
<p>Make sure that the merge is a fast-forward merge.</p>
473
+
<pre><code>git push
474
+
</code></pre>
475
+
443
476
<h1id="versioning-a-new-release">Versioning a New Release</h1>
444
477
<p>The decision to version a new release is based on the following factors:</p>
0 commit comments