Skip to content

Commit 6704472

Browse files
committed
docs: Add migration notes
1 parent afefc60 commit 6704472

File tree

4 files changed

+44
-0
lines changed

4 files changed

+44
-0
lines changed

MIGRATION

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Migration notes
2+
3+
Migration and deprecation notes for vcspull are here, see {ref}`changelog` as
4+
well.
5+
6+
```{admonition} Welcome on board! 👋
7+
1. 📌 For safety, **always** pin the package
8+
2. 📖 Check the migration notes _(You are here)_
9+
3. 📣 If you feel something got deprecated and it interrupted you - past, present, or future - voice your opinion on the [tracker].
10+
11+
We want to make vcspull fun, reliable, and useful for users.
12+
13+
API changes can be painful.
14+
15+
If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here!
16+
17+
(Please pin the package. 🙏)
18+
19+
[tracker]: https://github.com/vcs-python/vcspull/discussions
20+
```
21+
22+
## Next release
23+
24+
_Add migration notes here_
25+
26+
<!---
27+
# vim: set filetype=markdown:
28+
-->

docs/history.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
(changes)=
2+
(changelog)=
13
(history)=
24

5+
```{currentmodule} libtmux
6+
7+
```
8+
39
```{include} ../CHANGES
410
511
```

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,6 @@ configuration/index
3535
api
3636
developing
3737
history
38+
migration
3839
GitHub <https://github.com/vcs-python/vcspull>
3940
```

docs/migration.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
(migration)=
2+
3+
```{currentmodule} libtmux
4+
5+
```
6+
7+
```{include} ../MIGRATION
8+
9+
```

0 commit comments

Comments
 (0)