gtg-user team mailing list archive

["Lionel Dricot" <ploum@xxxxxxxxx>]

> Hello there,
>
> first of all: thank you for this great tool!!! Simple, effective,
> useable! I've searched all long time for such a gtd-tool (especially for
> gnome).

Thanks :-) It's always nice to receive friendly message.
>
> Now it's payback time. I would like to participate in developing,
> translating or just documenting. I'm Senior PHP-Developer from Germany
> and would like to increase my python-skills.
>
> I have a couple of questions on how to start:
>
> * is any kind of technical documentation available (e.g. uml-diagrams)?

No. Personnaly, I'm not an UML fan at all. I admit that we should do
diagram for the big picture which is basically the following.

CORE is the central piece which consists of :
- datastore.py : the main logic that will manage tasks and retrieve/store
them with the backends. This class is the only class that will ever
interact with backend.
- requester.py : the interface to the store. Every requests should use the
requester. The requester is the only to have access to the datastore. Upon
requests, requester can give you a list of tasks or a task object.
- tasks.py : the task object

BACKENDS (as the name suggests)

TASKBROWSER : one GUI to handle list of tasks
TASKEDITOR : another GUI which handler task individudally


It means that you have basically the following flow :

Backend <-> Datastore <-> Requester <-> Taskbrowser,taskeditor

> * what about coding conventions?

Python doesn't require so much coding convention as most of them are
syntaxic anyway.

Nevertheless, our coding conventions :

1) Clear code. Don't spare lines. Be clear
2) Comment *a lot*. Explain what your are doing.
3) Passing pylint test (see in scripts/codecheck.sh). Unfortunatly, the
test is not passing for a long time.

> * which development enviroment are you using (e.g. eclipse)

We want to stay IDE neutral. You can use any tool you want with the
condition that it does not impact the repository and/or other developpers.
Some IDE are putting files in the project : you can do whatever you want
locally but we will never accept that in a commit.


>
> Thanks, Jens.

Thanks for your nice word :-)

Lionel

>
> _______________________________________________
> Mailing list: https://launchpad.net/~gtg-user
> Post to     : gtg-user@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~gtg-user
> More help   : https://help.launchpad.net/ListHelp
>