Skip to content

Commit 6bbd286

Browse files
committed
Add notes on how to cut a release.
1 parent 2cbf9e8 commit 6bbd286

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

doc/overview.rst renamed to doc/development.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
Developer's Overview
22
====================
33

4-
Explore the source code on bitbucket:
4+
5+
Contributing
6+
------------
7+
8+
Contribute to source code, documentation, examples and report issues on bitbucket:
59
https://bitbucket.org/hardbyte/python-can
610

711

12+
Creating a Release
13+
------------------
14+
15+
- Release from the ``default`` branch.
16+
- Update the library version in ``setup.py`` and in ``doc/conf.py`` using
17+
`semantic versioning <http://semver.org>`__.
18+
- Run all tests and examples against available hardware.
19+
- Update `CONTRIBUTORS.txt` with any new contributors.
20+
- Sanity check that documentation has stayed inline with code. For large changes update ``doc/history.rst``
21+
- Create a temporary virtual environment. Run ``python setup.py install`` and ``python setup.py test``
22+
- Create and upload the distribution: ``python setup.py sdist bdist_wheel upload --sign``
23+
- In a new virtual env check that the package can be installed with pip: ``pip install python-can``
24+
825
Code Structure
926
--------------
1027

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Contents:
4545
interfaces
4646
protocols
4747
bin
48-
overview
48+
development
4949
history
5050

5151

0 commit comments

Comments
 (0)