Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Add some more details to how to write a pull request.
  • Loading branch information
nicolasbock committed Oct 29, 2017
1 parent 84151ae commit 7f64c01
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 18 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@ summarize:
- Push the branch to your forked repository
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'

During the review process it might become necessary to update your
pull request. Simply commit the changes on your local branch and push
them to GitHub. Please don't `amend` your commits. This makes it more
difficult for the reviewers to follow your work.

Please make sure your pull request contains only one logical change (see
During the review process you might want to update your pull
request. Please add commits or `amend` your existing commits as
necessary. If you amend any commits you need to add the
`--force-with-lease` option to the `git push` command. Please make
sure that your pull request contains only one logical change (see
["Structural split of
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
for further details.
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,11 @@ summarize:
- Push the branch to your forked repository
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'

During the review process it might become necessary to update your
pull request. Simply commit the changes on your local branch and push
them to GitHub. Please don't `amend` your commits. This makes it more
difficult for the reviewers to follow your work.

Please make sure your pull request contains only one logical change (see
During the review process you might want to update your pull
request. Please add commits or `amend` your existing commits as
necessary. If you amend any commits you need to add the
`--force-with-lease` option to the `git push` command. Please make
sure that your pull request contains only one logical change (see
["Structural split of
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
for further details.
Expand Down
11 changes: 5 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,11 @@ summarize:
- Push the branch to your forked repository
- Go to https://github.com/lanl/bml and click on 'Create Pull Request'

During the review process you might want to change your pull request. Simply
commit the changes on your local branch and push them GitHub. Please don't
`amend` your commits. This makes it more difficult for the reviewers to follow
your work.

Please make sure your pull request contains only one logical change (see
During the review process you might want to update your pull
request. Please add commits or `amend` your existing commits as
necessary. If you amend any commits you need to add the
`--force-with-lease` option to the `git push` command. Please make
sure that your pull request contains only one logical change (see
["Structural split of
change"](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
for further details.
Expand Down

0 comments on commit 7f64c01

Please sign in to comment.