dev:git
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
dev:git [2022/11/23 10:30] – [Configuring SSH] Simplify using alternate key file dyrcona | dev:git [2024/04/09 13:17] (current) – [Bug Fix Release Note Commit Message Tag] stompro | ||
---|---|---|---|
Line 41: | Line 41: | ||
git config user.name " | git config user.name " | ||
| | ||
- | git checkout -b working_branch origin/master | + | git checkout -b working_branch origin/main |
# hack away | # hack away | ||
git commit -as # and enter a useful comment | git commit -as # and enter a useful comment | ||
Line 71: | Line 71: | ||
LP#24544: fix the quuxifier | LP#24544: fix the quuxifier | ||
+ | | ||
+ | Release-Note: | ||
| | ||
Signed-off-by: | Signed-off-by: | ||
Line 89: | Line 91: | ||
Signed-off-by: | Signed-off-by: | ||
Signed-off-by: | Signed-off-by: | ||
+ | |||
+ | ===== Bug Fix Release Note Commit Message Tag ===== | ||
+ | |||
+ | For simple bug fixes that can be described with one line, include a line that starts with " | ||
+ | |||
+ | ==== Use Present Tense ==== | ||
+ | |||
+ | " | ||
+ | |||
+ | If the bug fix needs more explanation, | ||
+ | |||
+ | Examples: | ||
+ | Release-Note: | ||
+ | Release-Note: | ||
+ | ===== Testing Plan ===== | ||
+ | |||
+ | Include a testing plan to ensure that any testers of your patch can quickly understand how to see the original problem and know how to confirm that the fix works. | ||
+ | |||
+ | It is also acceptable to include the testing plan in the Launchpad ticket, but a note in the commit message such as "See LP bug report for testing plan" can make sure the tester knows where to find it. | ||
===== Sign-offs ===== | ===== Sign-offs ===== | ||
Line 103: | Line 124: | ||
The easiest way to sign-off on one or more commits is to: | The easiest way to sign-off on one or more commits is to: | ||
- | - Create a new branch based on current | + | - Create a new branch based on current |
- Cherry-pick the commits using the '' | - Cherry-pick the commits using the '' | ||
- **Test** to ensure that everything still works | - **Test** to ensure that everything still works | ||
Line 112: | Line 133: | ||
</ | </ | ||
- | We typically create branches for review that have the pertinent commits at the tip of the branch - that is, the most recent commits. However, if a long-lived branch has merged changes from master | + | We typically create branches for review that have the pertinent commits at the tip of the branch - that is, the most recent commits. However, if a long-lived branch has merged changes from main over time, you might need to use a tool like '' |
For example, to sign-off on two commits with hashes matching '' | For example, to sign-off on two commits with hashes matching '' | ||
- | # Ensure you have the latest revision of master | + | # Ensure you have the latest revision of main |
$ git fetch --all | $ git fetch --all | ||
- | $ git checkout -b openurl-more origin/master | + | $ git checkout -b openurl-more origin/main |
# or if the intention is to backport to the rel_2_1 release: | # or if the intention is to backport to the rel_2_1 release: | ||
# git checkout -b openurl-more_rel_2_1 origin/ | # git checkout -b openurl-more_rel_2_1 origin/ | ||
Line 133: | Line 154: | ||
==== Branches ==== | ==== Branches ==== | ||
- | The tip of Evergreen development is '' | + | The tip of Evergreen development is '' |
====== Community Git Repository ====== | ====== Community Git Repository ====== | ||
Line 240: | Line 261: | ||
* Galen Charlton | * Galen Charlton | ||
- | * Thomas Berezansky | ||
- | * Dan Scott | ||
* Jason Stephenson | * Jason Stephenson | ||
Line 257: | Line 276: | ||
< | < | ||
- | # git url origin/master | + | # git url origin/main |
- | For sharing origin/master | + | For sharing origin/main via the remote repo origin: |
Change remote_name as appropriate in the below commands. | Change remote_name as appropriate in the below commands. | ||
Line 270: | Line 289: | ||
Once you have the remote added you can check out this branch: | Once you have the remote added you can check out this branch: | ||
- | git checkout -b master | + | git checkout -b main remote_name/ |
</ | </ | ||
dev/git.1669217435.txt.gz · Last modified: 2022/11/23 10:30 by dyrcona