@@ -72,8 +72,12 @@ These steps are a guideline on how to add a new backend to python-can.
72
72
- Register your backend bus class in ``BACKENDS `` in the file ``can.interfaces.__init__.py ``.
73
73
- Add docs where appropriate. At a minimum add to ``doc/interfaces.rst `` and add
74
74
a new interface specific document in ``doc/interface/* ``.
75
- Also, don't forget to document your classes, methods and function with docstrings.
75
+ It should document the supported platforms and also the hardware/software it requires.
76
+ A small snippet of how to install the dependencies would also be useful to get people started without much friction.
77
+ - Also, don't forget to document your classes, methods and function with docstrings.
76
78
- Add tests in ``test/* `` where appropriate.
79
+ To get started, have a look at ``back2back_test.py ``:
80
+ Simply add a test case like ``BasicTestSocketCan `` and some basic tests will be executed for the new interface.
77
81
78
82
79
83
Code Structure
@@ -104,7 +108,7 @@ Creating a new Release
104
108
- Update the library version in ``__init__.py `` using `semantic versioning <http://semver.org >`__.
105
109
- Check if any deprecations are pending.
106
110
- Run all tests and examples against available hardware.
107
- - Update `CONTRIBUTORS.txt ` with any new contributors.
111
+ - Update `` CONTRIBUTORS.txt ` ` with any new contributors.
108
112
- For larger changes update ``doc/history.rst ``.
109
113
- Sanity check that documentation has stayed inline with code.
110
114
- Create a temporary virtual environment. Run ``python setup.py install `` and ``tox ``.
0 commit comments