Skip to content

Commit

Permalink
Use imperative mood for commit message examples
Browse files Browse the repository at this point in the history
This is widely agreed as the preferred style for commit messages.
  • Loading branch information
joeshannon committed Mar 5, 2024
1 parent c3ead02 commit 80079b6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/tutorials/adopt-existing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ If you have a [python3-pip-skeleton](https://github.com/DiamondLightSource/pytho
copier copy gh:DiamondLightSource/python-copier-template --trust --vcs-ref=1.0.0 /path/to/existing-project
git diff
# Examine the changes, put back anything you want to keep
git commit -m "Adopted python-copier-template 1.0.0"
git commit -m "Adopt python-copier-template 1.0.0"
copier update --trust /path/to/existing-project
git diff
# Examine the changes, resolve any merge conflicts
git commit -m "Updated to python-copier-template x.x.x"
git commit -m "Update to python-copier-template x.x.x"
```

## If you do not have a skeleton-based project
Expand All @@ -36,7 +36,7 @@ If you have a project with a different structure then it is best to go straight
copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/existing-project
git diff
# Examine the changes, put back anything you want to keep
git commit -m "Adopted python-copier-template x.x.x"
git commit -m "Adopt python-copier-template x.x.x"
```

:::{note}
Expand Down

0 comments on commit 80079b6

Please sign in to comment.