Skip to content

Commit 48e8ba1

Browse files
Copilotjbampton
andauthored
docs: rename branch example from add-your-github-username to my-feature-branch
Agent-Logs-Url: https://github.com/NextCommunity/NextCommunity.github.io/sessions/cb020662-42cd-42ae-acc3-6a62280854e0 Co-authored-by: jbampton <418747+jbampton@users.noreply.github.com>
1 parent 3d9aa3d commit 48e8ba1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ git checkout main
9595
git pull upstream main
9696

9797
# Create and switch to a new feature branch
98-
git checkout -b add-your-github-username
98+
git checkout -b my-feature-branch
9999
```
100100

101101
Use a descriptive branch name that reflects your change, e.g. `add-jbampton` or `fix-yaml-typo`.
@@ -156,8 +156,8 @@ git add src/users/your-github-username.yaml
156156
git commit -m "Add [Your Name] to developer directory"
157157
158158
# Push your feature branch to your fork (NOT main!)
159-
# Replace 'add-your-github-username' with the branch name you created in Step 3
160-
git push origin add-your-github-username
159+
# Replace 'my-feature-branch' with the branch name you created in Step 3
160+
git push origin my-feature-branch
161161
```
162162

163163
### Step 8: Create a Pull Request
@@ -415,14 +415,14 @@ A feature branch isolates your work so that `main` stays clean and ready to sync
415415

416416
```bash
417417
# Create a new branch and switch to it
418-
git checkout -b add-your-github-username
418+
git checkout -b my-feature-branch
419419
420420
# List all local branches (the active branch is marked with *)
421421
git branch
422422
423423
# Switch between existing branches
424424
git checkout main
425-
git checkout add-your-github-username
425+
git checkout my-feature-branch
426426
```
427427

428428
Branch naming conventions used in this project:
@@ -445,7 +445,7 @@ When `main` has moved forward since you created your branch, `git rebase` re-app
445445
git fetch upstream
446446
447447
# Rebase your feature branch on top of upstream/main
448-
git checkout add-your-github-username
448+
git checkout my-feature-branch
449449
git rebase upstream/main
450450
```
451451

@@ -467,7 +467,7 @@ After rebasing, you'll need to force-push your feature branch because the commit
467467

468468
```bash
469469
# Force push — only safe on your own feature branch, NEVER on main
470-
git push origin add-your-github-username --force-with-lease
470+
git push origin my-feature-branch --force-with-lease
471471
```
472472

473473
> ⚠️ `--force-with-lease` is safer than `--force`: it fails if someone else has pushed to your branch since you last fetched, preventing accidental data loss.
@@ -485,7 +485,7 @@ git stash
485485
# Switch to another branch, do some work, then come back
486486
git checkout main
487487
git pull upstream main
488-
git checkout add-your-github-username
488+
git checkout my-feature-branch
489489
490490
# Restore your stashed changes
491491
git stash pop
@@ -533,14 +533,14 @@ git merge upstream/main # or: git pull upstream main
533533
git push origin main
534534
535535
# 3. Create a new feature branch from the freshly synced main
536-
git checkout -b add-your-github-username
536+
git checkout -b my-feature-branch
537537
538538
# 4. Make your changes, then stage and commit them
539539
git add src/users/your-github-username.yaml
540540
git commit -m "Add [Your Name] to developer directory"
541541
542542
# 5. Push your feature branch to your fork on GitHub
543-
git push origin add-your-github-username
543+
git push origin my-feature-branch
544544
545545
# 6. Open a Pull Request on GitHub from your feature branch → NextCommunity/main
546546
```
@@ -550,7 +550,7 @@ If your feature branch gets out of date while you're working on it (because `mai
550550
```bash
551551
git fetch upstream
552552
git rebase upstream/main
553-
git push origin add-your-github-username --force-with-lease
553+
git push origin my-feature-branch --force-with-lease
554554
```
555555

556556
---

0 commit comments

Comments
 (0)