Skip to content

Commit db9f1ec

Browse files
gr8shivamthinkingserious
authored andcommitted
Document new Git workflow (#78)
* Update PULL_REQUEST_TEMPLATE * Update CONTRIBUTING.md
1 parent c47019b commit db9f1ec

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

.github/PULL_REQUEST_TEMPLATE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Closes #2
1212
### Checklist
1313
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
1414
- [ ] I have read the [Contribution Guide] and my PR follows them.
15-
- [ ] I updated my branch with the master branch.
15+
- [ ] I updated my branch with the development branch.
1616
- [ ] I have added tests that prove my fix is effective or that my feature works
1717
- [ ] I have added necessary documentation about the functionality in the appropriate .md file
1818
- [ ] I have added in line documentation to the code I modified

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,15 @@ Generally, we follow the style guidelines as suggested by the official language.
128128
2. If you cloned a while ago, get the latest changes from upstream:
129129

130130
```bash
131-
git checkout <dev-branch>
132-
git pull upstream <dev-branch>
131+
git checkout development
132+
git pull upstream development
133133
```
134134

135135
3. Create a new topic branch (off the main project development branch) to
136136
contain your feature, change, or fix:
137137

138138
```bash
139-
git checkout -b <topic-branch-name>
139+
git checkout -b <topic-branch-name> development
140140
```
141141

142142
4. Commit your changes in logical chunks. Please adhere to these [git commit
@@ -152,7 +152,7 @@ Generally, we follow the style guidelines as suggested by the official language.
152152
5. Locally merge (or rebase) the upstream development branch into your topic branch:
153153

154154
```bash
155-
git pull [--rebase] upstream master
155+
git pull [--rebase] upstream development
156156
```
157157

158158
6. Push your topic branch up to your fork:
@@ -162,6 +162,6 @@ Generally, we follow the style guidelines as suggested by the official language.
162162
```
163163

164164
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
165-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
165+
with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.
166166

167167
If you have any additional questions, please feel free to [email](mailto:[email protected]) us or create an issue in this repo.

0 commit comments

Comments
 (0)