Friday, June 04, 2010

Documentation on the way

In order to make it easy for newcomers to contribute to emesene 2 I'm creating documentation about the code structure, code guidelines and tools we use.

I would like to ear what kind of documentation would you like to see and would be useful.

please comment

12 comments:

Otacon said...

I don't think i'll write anymore for emesene...but, in case, SURELY will be useful to have:
-> A list of the signals (classes that produces it, and classes that receives it);
-> Class UML with brief explanation and, obviousely, inheritance!!!
-> "How does xxyyzz works?": i.e. Plugins system / Dynamic GUI components / ...;
-> How to create my GUI/Plugin extension?
-> For each file a sumpt of what it contains!!!

Diego Sarmentero said...

The UI design, how extensions works...

Dimitris said...

hi, i have just read i book for programming in python, so i just know the basic stuff.. will it be easy to to follow the project and to contribute at any level? some basic guidelines would help allot! if this is a bit too much for this post a personal message would be great.. i seriously would like to get aboard this project! cheers!

luismarianoguerra said...

@Dimitris: you could start reviewing the bugs tagged as easy or you could improve the code quality using pylint, that way you will have to read the code while improving it and making small changes, later you could start with more complex ones.

Dimitris said...

sounds like a great way to start!:> thanks!!

Mathias said...

UML is a must! Without that you can't speak of documentation

Dimitris said...

ok, where do i find the list with the bugs?:P i'm starting with my exams tomorrow and i'm searching for a reason to stop studying :P

luismarianoguerra said...

@dimitris: http://github.com/emesene/emesene/issues

Forgnet said...

I love emesene and I'd like to see some documentation more like Otacon described it. I have some experience in programming, all tho not that much in python.

But I'll sure hook up to the updates and it'd be cool to help out in an open source project like this.

I would like to see documentation written for people like me who have never really being of any useful help in an OSS project before.

Lauchazombie said...

Keep on with this awesome job! :)

Igor said...

Hi Mariano and other developers, I like emesene very much and I would like to contribute with the project. So as Dimitris my knowledge of python is nothing, but I already program in advanced C++. I'll follow your advices and try to start with minor bugs.
I'm already a developer in some other open source projects and I know that sometimes is hard to find developers to help... but I just wanted to say you have done a great job until now =)

luismarianoguerra said...

@Igor: great, if you have a doubt ask it in the mailing list!