Skip to content

Commit

Permalink
chore: Update docs to reflect the new default branch (#524)
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveTryon committed Feb 26, 2021
1 parent 3f502dc commit f73d767
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Please review the [Code of Conduct](./CODE_OF_CONDUCT.md) for this project.

### Contribution model
All contributions to this project should be through pull requests (PR) against the `master` branch.
All contributions to this project should be through pull requests (PR) against the `main` branch.

Before you start, make sure you have read the [Git branch setup instructions](./docs/GitBranchSetup.md).

Expand Down
19 changes: 12 additions & 7 deletions docs/GitBranchSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,32 @@ upstream https://github.com/Microsoft/axe-windows (push)

- At this point you are ready to start branching and contributing back changes.

## Default branch

As of February 2021, the default branch is the `main` branch

## Making code changes and creating a pull request

Create a branch from your fork and start making the code changes. Once you are happy with the changes, and want to merge them to the main **axe-windows** project, create a pull request from your branch directly to "Microsoft/axe-windows master".
Create a branch from your fork and start making the code changes. Once you are happy with the changes, and want to merge them to the main **axe-windows** project, create a pull request from your branch directly to "Microsoft/axe-windows main".

## Merging upstream master into your fork master
## Merging upstream main into your fork main

From time to time, your fork will get out of sync with the upstream remote. Use the following commands to get the master branch of your fork up to date.
From time to time, your fork will get out of sync with the upstream remote. Use the following commands to get the main branch of your fork up to date.

```bash
git fetch upstream
git checkout master
git pull upstream master
git checkout main
git pull upstream main
git push
```

## Merging upstream master into your current branch
## Merging upstream main into your current branch

Use these commands instead if you would like to update your current branch in your fork from the upstream remote.

```bash
git fetch upstream
git pull upstream master
git pull upstream main
git push
```

0 comments on commit f73d767

Please sign in to comment.