Skip to content

Commit

Permalink
Update CONTRIBUTING.md for main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
azarz authored Dec 31, 2024
1 parent 8b752a8 commit f99b1b7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ If you would like for the GitHub UI to link the commit to your account and award

#### Step 2 : Branch

As a best practice to keep your development environment as organized as possible, create local branches to work within. When you create a branch, do it directly off of the upstream **develop** branch.
As a best practice to keep your development environment as organized as possible, create local branches to work within. When you create a branch, do it directly off of the upstream **main** branch.

```
git checkout upstream develop
git checkout upstream main
git checkout -b my-branch
```

Expand Down Expand Up @@ -145,13 +145,13 @@ Note that multiple commits often will get squashed when they are landed.
As a best practice, once you have committed your changes, it is a good idea to use `git rebase` (not `git merge`) to synchronize your work with the main repository.

```
git checkout upstream develop
git pull upstream develop
git checkout upstream main
git pull upstream main
git checkout my-branch
git rebase develop
git rebase main
```

This ensures that your working branch has the latest changes from the develop branch of the origin repository. Moreover, your Pull Request will be easier to merge.
This ensures that your working branch has the latest changes from the main branch of the origin repository. Moreover, your Pull Request will be easier to merge.

#### Step 6 : Test

Expand Down Expand Up @@ -195,10 +195,10 @@ git push origin my-branch
If a git conflict arises, it is necessary to synchronize your branch with other changes that have landed upstream by using git `rebase`:

```
git checkout upstream develop
git pull upstream develop
git checkout upstream main
git pull upstream main
git checkout my-branch
git rebase develop
git rebase main
git push --force origin my-branch
```

Expand Down

0 comments on commit f99b1b7

Please sign in to comment.