Skip to content

Commit 0b011d9

Browse files
committed
Update README.
1 parent 79426eb commit 0b011d9

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

‎README.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ Releasing new version and deploy to PyPi
9191

9292
Uploading to PyPi is done via `twine <https://pypi.org/project/twine/>`__.
9393

94-
In the steps below, replace "X.X.X" with the appropriate version number.
94+
In the steps below and **after merging to ``main``**, replace "X.X.X" with the appropriate version number.
95+
96+
See `Semantic Versioning <https://semver.org/>`__ for recommendations on picking version numbers.
9597

9698
.. code:: bash
9799
@@ -113,19 +115,20 @@ In the steps below, replace "X.X.X" with the appropriate version number.
113115
git tag -a X.X.X -m "version X.X.X"
114116
git push origin X.X.X
115117
116-
On `GitHub <https://github.com/ebezzam/pydevtips/tags>`__ set the new tag
117-
by (1) clicking "..." and selecting "Create release" and (2) at the bottom
118-
pressing “Publish release”.
118+
On `GitHub <https://github.com/ebezzam/python-dev-tips/tags>`__ set the new tag
119+
by (1) clicking (the rightmost) "..." and selecting "Create release" and (2) at the bottom
120+
pressing "Publish release".
119121

120122

121123
TODO
122124
====
123125

126+
- joblib example in profile
124127
- github page
125128
- point out features in scripts: object-oriented, asserts, tqdm, type hints
126129
- matplotlib, pytest, black in dev install
127130
- example file with hydra
128131
- manifest file to not include file in package
129-
- GitHub actions for releasing to PyPi
132+
- GitHub actions for releasing to PyPi when changes to version
130133
- documentation (autodoc)
131134
- adding badges to README

0 commit comments

Comments
 (0)