Beginners Contributing Work
The tasks described in this section can be done by non expèrt
developers. The review of project documentation, user manuals and API
reference is the best work to start, learning the main features of
Fisterra Development Framework and how to develop with Fisterra.
Another task to do for beginner developers is the modification of
interfaces to adapt the to the HIG recommendations.
Task description
The first step to began this work is to download the source from CVS
repository of Fisterra-Base and Fisterra-Bmodules software. This source
provide a lot of documentation, which must be compiled to generate html.
The tasks defined are focused in the following areas :
- Documentation tasks
- Interface modification tasks
- Code cleaning tasks
The documentation and tools required to do this work are :
- Fisterra documentation system
Documentation tasks
These section describe the work to manage all project documentation,
including user manuals, developers guides, API reference, ....
The translate tasks are very important too, because this is a community
project that can be available for developers and collaborators around the
world. You can contribute to increase the accessibility of this
technology.
Review API documentation
- Status : pending
- Developers :
- Coordination notes :
- Description : This task has the main target of complete the API reference documentation for all public methods.
The API reference in Fisterra project, as in the most of gnome projects is generated using GTK-Doc API Documentation Generator. This tool defines a set of rules to include the gtk-doc contents in the source code. The goal of this task is to review the gtk-doc comments of Fisterra-Base and Fisterra-Bmodules source code and fill these comments in all methods.
This work to do in this task can be summary in the following points :
- Review all gtk-doc comments
- Fill the methods with gtk-doc comments
Developer Guides
- Status : pending
- Developers :
- Coordination notes :
- Description : The Fisterra project provides a lot of documentation about base technologies and the basic modules to provide facilities to develop ERP applications. This documentation is available from cvs repository at libfisterra and fisterra-bmodules_ cvs modules.
To do the work defined on this task, you must install the fisterra-base and fisterra-bmodules development package. The Fisterra-Base software provide basic classes and utility functions. This software includes session management, data access code generation, communication management and other basic technologies.
The Fisterra-Bmodules define some modules to provide a general implementation to the common business logic, like taxes management, document workflow, personal information management, ....
All this software have its own source documentation, described using doc-book tools which can be compiled to generate html. You must review this documentation before to start development over Fisterra framework.
The target of this task is to complete the documentation, creating use guides to install the framework, configure the development environment and implement use cases.
This work to do in this task can be summary in the following points :
- Install the Fisterra-Base and Fisterra-Bmodules development packages
- Review all documentation
- Define a requirement document for a new use case
- Register the analysis and design work in the project documentation
- Implement the use case using the Fisterra Gnome Development Framework
- Complete the documentation
- Fisterra-Base documentation
- Class diagrams of class hierarchy
- Guide to install the development framework
- Guide to configure the development environment
- How to start a new use case implementation
- Fisterra-BModules documentation
User Guides
- Status : pending
- Developers :
- Coordination notes :
- Description : The Fisterra-Distribution is a simple test application to show how Fisterra framework works. It has a requirement document to describe the use cases implemented. In addition, it provides the analysis and design documentation of these use cases.
The work to do in this task can be divided in two phases :review the requirement and analysis documentation and define use guides.
In the first phase, you can examine a use case requirement specification. You can update this document with you own knowledge and experience about the business process, adding the requirements you think they must be part of the use case.
The second phase of this task is the definition of an user guide to use the Fisterra-Distribution application. This guide must describe in detail all functionalities implemented in the application.
This work to do in this task can be summary in the following points :
- Install the Fisterra-Base, Fisterra-Bmodules and Fisterra-Distribution packages.
- Review requirement and analysis documentation
- Adding or modify the requirements
- Test Fisterra-Distribution
- Create an User Guide for all implemented use cases
Internacionalization
- Status : pending
- Developers :
- Coordination notes :
- Description : This task defines the work to complete the internationalization of Fisterra-Distribution test application and the string defined in the Fisterra-Base and Fisterra-BModules software.
The documentation must be translated too, in order to increase the accessibility of the project to developers communities around the world.
The internationalization system is same as the most gnome projects, based on gettext internationalization tools. These tools define a macros to ark the string to translate on the source code. This marked string are translated in *.po files; one file for each language. The gettext tools will replace the strings in the source code with the strings defined in the .po file.
This work to do in this task can be summary in the following points :
- Install the Fisterra-Base, Fisterra-Bmodules and Fisterra-Distribution packages.
- Review all strings in the source code and mark them to be managed by gettext.
- Create the _*.po* files with the translated strings.
Interface tasks
These task are defined to modify the interfaces of Fisterra framework and Fisterra-Distribution test application, to adapt them to the Gnome HIG standard and make improvements in usability and desing.
Interface and HIG
- Status : pending
- Developers :
- Coordination notes :
- Description : This task defines the work to modify the interfaces provided by the widgets implemented on Fisterra-Base, Fisterra-BModules and Fisterra-Distribution to adapt it to GNOME Human Interface Guidelines.
This work to do in this task can be summary in the following points :
- Install the Fisterra-Base, Fisterra-Bmodules and Fisterra-Distribution packages.
- Review the GNOME Human Interface Guidelines.
- Modify the interfaces to adapt the to the HIG, using GLade tools.
Code cleaning tasks
These task are defined to easy changes in the code of the Fisterra framework and Fisterra-Distribution test application.
Use G_DEFINE_TYPE
- Status : pending
- Developers :
- Coordination notes :
- Description : Use the macro G_DEFINE_TYPE in order to define new types in Fisterra. This task involves:
- Remove the declarations of the class_init and instance_init functions
- Remove the get_type functions
- Add the G_DEFINE_TYPE macro instead the stuff mentioned above
--
JoseJuanGonzalez - 07 Mar 2006
Added the code cleaning section
--
SergioVillar - 20 Jul 2006
to top
