Help on contribution

0 views
Skip to first unread message

Lorenzo Vegetti

unread,
Jun 12, 2009, 3:36:20 AM6/12/09
to QxTransformer
As I've already said I'm new here. I'm also new with python (I usually
work in C#, Delphi...) and mako, but I still would like to help if I
can.
I'm a little lost in the code, can someone point to some developer
docs or show me the "entrance"?

Lorenzo

Siarhei Barysiuk

unread,
Jun 12, 2009, 4:01:10 AM6/12/09
to qxtran...@googlegroups.com
Hi Lorenzo,

We would love to see you in our small team as a new contributor.

All our docs you can find in project's wiki:
http://qxtransformer.org/a/qxtransformer.org/qxtransformer/Documentation

But it's documentation mostly for end-users (and it does not cover all
what we have).
We were planning to create documentation for developers but it was
long-terms plans
since we hadn't any contributors, just I and Christian. But now it's
time to start working
on it, I think :)

What would you like to see in documentation?

Here is my draft plan:
1) High level architecture
2) Brief description for each file in project
3) Classes description
4) Dialects and how to build an own
5) How to extends existing dialect
6) ....

What do you think about this? Any other ideas?

Also if you would like to start with Python I can recommend Dive In Python book.
http://www.diveintopython.org/

Mako templates project has a pretty good documentation. Check this out:
http://www.makotemplates.org/
But we have some helpers in mako templates which performs basic operations, so
I should describe them as well.

Again, If you have any questions, please ask us. We would love to help
you and also we
will get idea which parts is not documented well, what we should
describe in more details,
etc.

Best regards,
Siarhei

P.S. Christian, join us on this.

Lorenzo Vegetti

unread,
Jun 12, 2009, 4:55:57 AM6/12/09
to QxTransformer
> What would you like to see in documentation?
>
> Here is my draft plan:
> 1) High level architecture
> 2) Brief description for each file in project
> 3) Classes description
> 4) Dialects and how to build an own
> 5) How to extends existing dialect
> 6) ....
>
This looks like a perfect plan. I realize and don't expect to have
"the supper ready" (as we say here in Italy), I expect I will have to
dive into the code, but now I don't know where to start. So: the high
level architecture is surely what I believe is most needed, along with
an even short description of the files that contain the "entry
points", I hope I will be able to follow the flow from there...

Thanks, you are doing a great job! It's a long time I've been
following qooxdoo, but this (and thanks to qxtransformer!) is the
first time I believe it's really worth trying to build an application
with it (and don't waste ages debugging trivial problems in the UI
code).

Lorenzo

Reply all
Reply to author
Forward
0 new messages