| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 1 | ================== |
| 2 | Hacking on reclass |
| 3 | ================== |
| 4 | |
| 5 | Installation |
| 6 | ------------ |
| 7 | If you just want to run |reclass| from source, e.g. because you are going to be |
| 8 | making and testing changes, install it in "development mode":: |
| 9 | |
| 10 | python setup.py develop |
| 11 | |
| 12 | Now the ``reclass`` script, as well as the adapters, will be available in |
| 13 | ``/usr/local/bin``, and you can also invoke them directly from the source |
| 14 | tree. |
| 15 | |
| 16 | To uninstall:: |
| 17 | |
| 18 | python setup.py develop --uninstall |
| 19 | |
| 20 | Discussing reclass |
| 21 | ------------------ |
| martin f. krafft | 0b157d6 | 2013-08-27 18:52:47 +0200 | [diff] [blame] | 22 | If you want to talk about |reclass|, use the `mailing list`_ or to find me on |
| 23 | IRC, in ``#reclass`` on ``irc.oftc.net``. |
| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 24 | |
| martin f. krafft | 0b157d6 | 2013-08-27 18:52:47 +0200 | [diff] [blame] | 25 | .. _mailing list: http://lists.pantsfullofunix.net/listinfo/reclass |
| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 26 | |
| 27 | Contributing to reclass |
| 28 | ----------------------- |
| 29 | |reclass| is currently maintained `on Github |
| 30 | <http://github.com/madduck/reclass>`_. |
| 31 | |
| 32 | Conttributions to |reclass| are very welcome. Since I prefer to keep a somewhat |
| 33 | clean history, I will not just merge pull request. |
| 34 | |
| 35 | You can submit pull requests, of course, and I'll rebase them onto ``HEAD`` |
| 36 | before merging. Or send your patches using ``git-format-patch`` and |
| martin f. krafft | 5a8d02f | 2013-08-28 12:04:22 +0200 | [diff] [blame] | 37 | ``git-send-e-mail`` to `the mailing list |
| 38 | <reclass@lists.pantsfullofunix.net>`_. |
| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 39 | |
| 40 | I have added rudimentary unit tests, and it would be nice if you could submit |
| 41 | your changes with appropriate changes to the tests. To run tests, invoke |
| 42 | |
| 43 | :: |
| 44 | |
| 45 | $ make tests |
| 46 | |
| 47 | in the top-level checkout directory. The tests are rather inconsistent, some |
| 48 | using mock objects, and only the datatypes-related code is covered. If you are |
| 49 | a testing expert, I could certainly use some help here to improve the |
| 50 | consistency of the existing tests, as well as their coverage. |
| 51 | |
| 52 | Also, there is a Makefile giving access to PyLint and ``coverage.py`` (running |
| 53 | tests). If you run that, you can see there is a lot of work to be done |
| 54 | cleaning up the code. If this is the sort of stuff you want to do — by all |
| 55 | means — be my guest! ;) |
| 56 | |
| martin f. krafft | cc8851d | 2013-08-27 13:43:16 +0200 | [diff] [blame] | 57 | There are a number of items on the :doc:`to-do list <todo>`, so if you are |
| 58 | bored… |
| 59 | |
| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 60 | If you have larger ideas, I'll be looking forward to discuss them with you. |
| 61 | |
| 62 | .. include:: substs.inc |