Skip to content

Commit

Permalink
fix(docs): add merging changes to workflow.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bzlibby authored and ssube committed Aug 23, 2020
1 parent ec1f336 commit 76cd161
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions docs/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ This guide covers the basic development workflow for projects based on https://g

## Common Tasks

These guides primarily reference terminal commands. If you are using VS Code or Github's desktop client instead:

- [Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol)
- [Contributing and Collaborating Using Github Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/)

### Branch Development

Development for each issue is done on a different branch:
Expand All @@ -26,7 +31,7 @@ Development for each issue is done on a different branch:
- write some tests
- `make ci`
- add or update docs, as needed
- create merge request
- create [merge request](#merging-changes)

Branch names are based on ticket type:

Expand All @@ -51,10 +56,33 @@ TODO

### Merging Changes

TODO: merging from a terminal
To stage your changes:

```shell
> git add <filename>
# adds a single file to staging
> git add <directoryname>
# adds all files in a single directory to staging
```

To commit your changes to the checked out branch:

```shell
> git commit
# commits any changes you've added to staging
> git commit -a
# commits all files; does not require staging changes first
> git commit -m "your commit message"
# allows you to add your commit message inline
```

To push your local changes to the repository:

```shell
> git push origin <branchname>
```

- If you are using VS Code: [Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol)
- If you are using Github's desktop client: [Syncing Your Branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/syncing-your-branch)
After you have pushed your local changes, you can create a pull request and merge from Github: [Proposing Changes to Your Work with Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)

### Test Coverage

Expand Down

0 comments on commit 76cd161

Please sign in to comment.