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