Skip to content

Commit

Permalink
improve upgrade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fzumstein committed Sep 17, 2024
1 parent 97c8154 commit 80b6952
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/repo_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If you only want to play around with xlwings Server without committing any chang
git remote add origin <URL>
```

6. To reduce future merge conflicts, run:
6. To reduce future merge conflicts with the help of `.gitattributes`, run:

```text
git config --local merge.ours.driver true
Expand Down
11 changes: 10 additions & 1 deletion docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,17 @@ This guide assumes that you have set up your local Git repository according to [
git push origin main
```

5. Update your requirements locally:
5. Update your requirements locally (if you use Docker, rebuild your container instead):

```text
uv pip sync requirements-dev.txt
```

```{admonition} Merge vs Rebase
Merge is recommended over Rebase:
- Potential merge conflicts can be resolves in a single step
- There's no force push required
- The history of your own commits is preserved
- [](repo_setup.md) minimizes merge conflicts during merge operations via `.gitattributes`
```

0 comments on commit 80b6952

Please sign in to comment.