Skip to content

Commit 7f64c01

Browse files
committed
Update README
Add some more details to how to write a pull request.
1 parent 84151ae commit 7f64c01

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed

CONTRIBUTING.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@ summarize:
1313
- Push the branch to your forked repository
1414
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'
1515

16-
During the review process it might become necessary to update your
17-
pull request. Simply commit the changes on your local branch and push
18-
them to GitHub. Please don't `amend` your commits. This makes it more
19-
difficult for the reviewers to follow your work.
20-
21-
Please make sure your pull request contains only one logical change (see
16+
During the review process you might want to update your pull
17+
request. Please add commits or `amend` your existing commits as
18+
necessary. If you amend any commits you need to add the
19+
`--force-with-lease` option to the `git push` command. Please make
20+
sure that your pull request contains only one logical change (see
2221
["Structural split of
2322
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
2423
for further details.

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,11 @@ summarize:
118118
- Push the branch to your forked repository
119119
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'
120120

121-
During the review process it might become necessary to update your
122-
pull request. Simply commit the changes on your local branch and push
123-
them to GitHub. Please don't `amend` your commits. This makes it more
124-
difficult for the reviewers to follow your work.
125-
126-
Please make sure your pull request contains only one logical change (see
121+
During the review process you might want to update your pull
122+
request. Please add commits or `amend` your existing commits as
123+
necessary. If you amend any commits you need to add the
124+
`--force-with-lease` option to the `git push` command. Please make
125+
sure that your pull request contains only one logical change (see
127126
["Structural split of
128127
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
129128
for further details.

docs/index.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,11 @@ summarize:
122122
- Push the branch to your forked repository
123123
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'
124124

125-
During the review process you might want to change your pull request. Simply
126-
commit the changes on your local branch and push them GitHub. Please don't
127-
`amend` your commits. This makes it more difficult for the reviewers to follow
128-
your work.
129-
130-
Please make sure your pull request contains only one logical change (see
125+
During the review process you might want to update your pull
126+
request. Please add commits or `amend` your existing commits as
127+
necessary. If you amend any commits you need to add the
128+
`--force-with-lease` option to the `git push` command. Please make
129+
sure that your pull request contains only one logical change (see
131130
["Structural split of
132131
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
133132
for further details.

0 commit comments

Comments
 (0)