Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributing/workflow.md #6447

Merged
merged 2 commits into from
Aug 29, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Clone your repository, leaving a local folder for you to work with:
> git clone ORIGIN_URL
```

## Syncing your repository
## Syncing Your Repository

Within your local repository, Git will have created an alias,
**origin**, for the GitHub repository it is bound to. You want to create
Expand Down Expand Up @@ -179,7 +179,11 @@ For instance, to commit your work from a debugging session:

Just make sure that your commits in a feature branch are all related.

### When you work on two features
### Changing a Commit Message

See <https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message>.

### When You Work on Two Features

If you are working on two features at a time, then you will want to
switch between them to keep the contributions separate. For instance:
Expand Down Expand Up @@ -314,7 +318,7 @@ And finally push your local branch to your GitHub repository:
> git push --force-with-lease origin fix/problem123
```

## If you sent to the wrong branch
## If You Sent to the Wrong Branch

If you have sent a PR to the wrong branch, you need to create a new PR branch.

Expand Down