Contributing to Jaws

There are many ways to contribute Jaws: reporting bugs, helping with development, submitting new ideas, documenting the framework…

Development

Jaws developers submit their code to a SVN server. As the contributors dosen’t have write access they have to send their patches to the mailing list. Go ML to subscribe.

You can get the current development code with anonymous access from svn using this command

svn co svn://dev.jaws-project.com/jaws/trunk/jaws <directory>

Note: if you want to get a functional jaws-devel module you also need to get some extra components. To do so you must execute a script located on /path/to/jaws-devel/html/include/Extras/get3rdparty.sh . This script will install those components under /path/to/jaws-devel/html/include/Extras/ .

Patches

If you want to add a new feature to Jaws, you should first e-mail jaws-dev@forge.novell.com, to make sure that nobody else is already working on the feature.

If nobody is working on it, then checkout Jaws from SVN, and start hacking on it. Once you’re done you can e-mail us again and lets us know where we can find the patch. If the patch fixes a bug, please also attach it to the bug it fixes so that it doesn’t get lost.

Regular contributors will be given SVN access so that they don’t have to constantly submit patches, but you will have to submit the first few times so that we can make sure you’re not going to break anything :-P

Bug Tracking (and fixing)

If you get some error while using Jaws you can report it on the Jaws BugTracker. This way you’re helping developers to fix the Jaws code and make it better each day ;-)

Quick Bug Reporting How-to

So you found an error on Jaws? Are you sure? ;-) Ok, nobody’s perfect :-) Before report it you must check if somebody else has reported the same bug before. To view all current bugs you must use our bug searching tool. Behind its spectacular interface there is a simple searching tool that will show you all reported bugs that matches with your searching parameters. There are not too much bugs reported by now, so you can simply press the “submit query” button and you will see all reported-but-non-fixed bugs.

If some bug summary seems similar to your bug don’t stop now: you can click on its “ID” to see all related info: who reported it, who’s working on it and -probably the most useful part- the bug description. If you can provide anymore information about the bug, you will be helping very much to the developers :-)

If there is no similar bugs reported, there is your chance to help us: you can report it by login-in (sorry, you must register the first time) and submitting the most complete description about your bug. Remember this: The best bug descriptions are those which help us to get the same bug: What environment were you working on when you found the bug? What action you were trying to do when you found the bug? What were you drinking when you found the bug?

After your bug reporting, we will put to some developer(s) to work on it, and it will be quickly fixed on the new Jaws version.

Note:If you want to help developers to fix bugs, you can also use the Jaws BugTracker to see what bugs aren’t still assigned. Just choose one, fix it and send us the patch :-)


Contribuyendo a Jaws

Traduccion al español por JASH

Existen muchas formas de contribuir a Jaws: reportando bugs, ayudando con el desarrollo, enviando nuevas ideas, documentando el ambiente de trabajo, etc.;

Desarrollo

Los desarrolladores de Jaws envían su código al servidor de SVN. Como los usuarios que contribuyen no tienen acceso de escritura, envían sus parches a la lista de correo. Vaya a la lista de correo para poder subscribirse. Ud puede obtener la última versión del código con acceso anónimo desde el servidor de svn usando este comando:

svn co svn://dev.jaws-project.com/jaws/trunk/jaws <directory>

Nota: Si Ud desea obtener una modulo funcional de jaws-desarrollo, Ud. necesitara además algunos componentes extra. Para esto, ejecute el script localizado en /path/to/jaws-devel/html/include/Extras/get3rdparty.sh . Este script instalara dichos componentes bajo /path/to/jaws-devel/html/include/Extras/ (Nota del traductor: este script funcionará en sistemas Linux/Unix con los permisos de ejecución adecuados).

Parches.

Si Ud. desea agregar una nueva característica a Jaws, debería primero enviar un e-mail a jaws-dev@forge.novell.com. Para asegurarse que nadie mas este trabajando en dicha característica. Si no existe nadie mas trabajando en ello, entonces puede hacer el “checkout” del SVN y comenzar a modificarlo. Una vez que haya terminado, puede enviarnos nuevamente un mail y hacernos saber donde encontraremos su parche. Si el parche corrige un “bug” (Fallo), por favor agregue el bug que corrige de modo que no se pierda.

A los usuarios que regularmente contribuyan se les podrá dar acceso al SVN de manera que no tengan que estar enviando sus parches constantemente por mail, pero al menos deberá enviarlos las primeras veces de forma que podamos estar seguros de que Ud. no va a romper nada :P (Nota del traductor: Carita burlona).

Seguimiento a fallos (Y corrección de las mismas)

Si Ud. recibe algún error mientras se encuentra utilizando Jaws puede reportarlo en el Jaws Bugtracker. De esta forma Ud. estará ayudando a los desarrolladores a corregir el código y hacerlo mejor cada día.

Guía rápida para reportar fallos

¿Así que encontró un error en Jaws?¿Esta seguro? OK, nadie es perfecto. Antes de reportarlo seria bueno verificar que nadie más ha reportado el mismo error antes. Para ver la lista de fallos actuales puede usar nuestra herramienta de búsqueda. Detrás la interfase espectacular se encuentra una simple herramienta de búsqueda que le mostrara todos los fallos que coincidan con sus parámetros de búsqueda. No hay muchos fallos reportados a la fecha, así que simplemente podría presionar el botón enviar y vería todos los fallos que han sido reportados pero aun no corregidos.

Si la descripción corta de algún fallo se parece al fallo que se le esta presentando, no se detenga: De clic en el identificados “ID” para ver toda la información relacionada, quien lo reporto, quien esta trabajando en el y probablemente la parte mas útil, la descripción completa del fallo. Si Ud. puede proveer alguna información extra acerca del fallo, seguramente será de mucha utilidad para los desarrolladores.

Si no existen fallos similares reportados, es una buena oportunidad para ayudarnos: Ud. puede reportarlo ingresando (Tiene que registrarse primero) y enviando la más completa descripción acerca del fallo. Recuerde que: La mejor descripción de un fallo es aquella que nos ayuda a obtener el mismo fallo, esto es: En que ambiente trabajaba cuando se presento el fallo? Que acción estaba tratando de realizar? Que demonios estaba bebiendo cuando se presento el fallo? etc.;

Después de que haya realizado su reporte, nosotros pondremos algunos desarrolladores a trabajar en el, y quedara rápidamente corregido en la próxima versión de Jaws.

Nota: Si Ud. desea ayudar a los desarrolladores a corregir algún fallo, puede usar el Jaws BugTracker para ver que fallos siguen sin ser asignados. Solo escoja uno, corríjalo y envíenos el parche. :-)

 
  /var/www/wiki/htdocs/data/jaws/development/contributing.txt · Last modified: 2007/11/02 16:27