File tree 2 files changed +19
-2
lines changed 2 files changed +19
-2
lines changed Original file line number Diff line number Diff line change 1
1
Developer's Overview
2
2
====================
3
3
4
- Explore the source code on bitbucket:
4
+
5
+ Contributing
6
+ ------------
7
+
8
+ Contribute to source code, documentation, examples and report issues on bitbucket:
5
9
https://bitbucket.org/hardbyte/python-can
6
10
7
11
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
+
8
25
Code Structure
9
26
--------------
10
27
Original file line number Diff line number Diff line change @@ -45,7 +45,7 @@ Contents:
45
45
interfaces
46
46
protocols
47
47
bin
48
- overview
48
+ development
49
49
history
50
50
51
51
You can’t perform that action at this time.
0 commit comments