README for distix
=================

**NOTE: distix is in its infancy. Its development has barely started.
  everything in this README is a speculation of what might be true
  eventually. Any similarity with reality is accidental, but we'll
  take credit for it anyway.***

Blurb
-----

distix is a distributed ticketing system, aimed at handling support
issues and bugs. For most people, it is an invisible agent that keeps
track of issues and bugs by being Cc'd on emails. There is no login
required. The emails do not need to follow any structure. Each email
thread becomes its own ticket. The support staff can search and
manipulate tickets using a command line tool.

distix is built using git, YAML, and Maildirs. This allows tickets to
be handled entirely offline, and synchronised between machines and
staff. There is currently no web interface.


Home page
---------

* <http://www.distix.eu/>
* <http://liw.fi/distix/>


Hacking
-------

To run the test suite:

   python setup.py check

You MUST successfully run the test suite before submitting patches.


Coding principles
-----------------

The code of `distix` is meant to obey all of the below:

* Code is clean and easy to understand.
* Code is maintainable, easy to modify, and easy to debug.
* There is no unnecessary code.
* Code is correct.
* All of the code is fully tested by unit tests, unless excplitly
  makred outside of test coverage; all exceptions are justified in
  code with a comment.
* All non-interactive user and program interfaces are tested by
  integration tests implemented with yarn. Testing of interactive user
  interaces may rely on manual testing.

Any failures to meet all of the above should be treated as bugs.

Code should be developed using test driven development.


Legalese
--------

Copyright 2014,2015  Lars Wirzenius

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

=*= License: GPL-3+ =*=