Differences

This shows you the differences between two versions of the page.

--- newdevs:git:create [2019/06/28 17:06] – tmccanna
+++ newdevs:git:create [2024/02/01 10:46] – [3. Make Your Changes] tmccanna
@@ Line 1: / Line 1: @@
+**New Developers Working Group**
 ====== Git for Windows ======
-===== Using Git to Create Patches =====
+===== Using Git to Create New Branches =====
+When you make code changes that you wish to post for review, you will create a git branch to store them in.
 ==== 1. Update Your Local Repository ====
@@ Line 8: / Line 10: @@
   - Open Git Bash
   - Navigate into your Evergreen repository
-  - If the master branch isn't currently checked out, check it out: git checkout master
+  - If the main branch isn't currently checked out, check it out: git checkout main
   - Before making any changes, make sure your local files are up to date with latest changes:
 <code bash>
-git pull origin master
+git pull origin main
 </code>
+Note: Depending on how Git is configured on your machine, you may just be able to enter: git pull
 ==== 2. Create a New Branch to Store Your Changes ====
-Create and checkout a branch to store your changes. The branch name should be in the format: user/your-git-user-name/launchpad#_brief_description
+Create and checkout a branch to store your changes. You can name the branch anything you like, but it is good practice to name it with a related launchpad bug number followed by a brief description:
 <code bash>
-git checkout -b user/username/lp123456_launchpad_bug_description
+git checkout -b lp123456_launchpad_bug_description
+</code>
+Note: In most cases you will want to create a branch based off of main. You can do this either by a) specifying main on the command line:
+<code bash>
+git checkout -b lp123456_launchpad_bug_description main
+</code>
+Or, b) you can switch to main first and then create the new branch. This also gives you the opportunity to make sure your local copy of main is updated first:
+<code bash>
+git checkout main
+git pull origin main
+git checkout -b lp123456_launchpad_bug_description
 </code>
 ==== 3. Make Your Changes ====
   - Edit the file(s) you wish to change. You can either do this by launching a text editor from within Git Bash (notepad++ filename.tt2) or you can do so by opening and editing the file from Windows Explorer.
   - Verify that Git recognizes the files you have modified: git status
   - Add the file(s) you have changed to the staging area:
-    * To stage a specific file, use: git add myfilename.txt
+    * To stage a specific file, use: **git add myfilename.txt**
     * To stage //all// changed files, use: git add -A
     * If you accidentally stage a file you didn't mean to, you can unstage it: git reset HEAD myfilename.txt
-  - Commit the staged changes: git commit
+  - If you are adding a new feature (as opposed to a bug fix), you will also need to create a release note file. Look in the RELEASE_NOTES_NEXT folder for a template and examples:
-  - When your text editor opens to write the commit message, the first line should be the launchpad number and name, followed by the description, followed by your sign off. For example:
+    * https://git.evergreen-ils.org/?p=Evergreen.git;a=tree;f=docs/RELEASE_NOTES_NEXT
+  - Commit the staged changes: **git commit -s**
+    * Note: The -s portion adds the sign-off line for you.
+  - When your text editor opens to write the commit message, the first line should be the launchpad number and name, followed by the description (with test instructions if relevant), then a brief release note line, and then followed by your sign off. For example:
   LP#1406387 Fix for Holds Placement Advanced Options
@@ Line 38: / Line 61: @@
   empty, regardless of whether the radio input for the
   hold was specified for a patron or the staff member.
+  To reproduce the problem:
+  [1] Open a patron's account and start the process to place a hold.
+  [2] On the hold placement screen, click Advanced Hold options.
+  [3] You will see that the staff barcode is filled in rather than the patron.
+  To test the fix:
+  [1] Open a patron's account and start the process to place a hold.
+  [2] On the hold placement screen, click Advanced Hold options.
+  [3] Verify that the patron barcode is filled in.
+  [4] Test placing a hold directly from the catalog and confirm that the
+  staff or patron barcode is carried over from the main hold page.
+  Release-note: Fixes issue where staff barcode populated the staff client advanced holds screen.
   Signed-off-by:  Jane Hacker <jhacker@example.org>
 ==== 4. Push Your Changes to the Evergreen Working Repo ====
-Upload (push) your changes:
+In order to share your branch, you will need to upload (push) it up to the Evergreen Git server. When you do this, enter your local branch name, then a colon, then the remote directory and name. In this example, jdoe would be your username:
 <code bash>
-git push working user/username/lp123456_launchpad_bug_description
+git push working lp123456_launchpad_bug_description:user/jdoe/lp123456_launchpad_bug_description
 </code>