Skip to content

Commit 5b25486

Browse files
committed
Added information in the CONTRIBUTE files to the developers, testers,
administrators and donators. It left the translators and the documenters and complete the developers part. The TODO files are now org TODO files. Added a directory to put the automatic tests.
1 parent 4532279 commit 5b25486

File tree

7 files changed

+280
-51
lines changed

7 files changed

+280
-51
lines changed

CONTRIBUTE.en

+67
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,84 @@ contact with [email protected] exposing your idea.
3434
Testers
3535
=========
3636

37+
The tests are one of the most important part of any project, because
38+
is the way to check that the software is working as expected. If you
39+
want to collaborate with the project making tests you have three ways
40+
to do it:
41+
42+
* Test the software by hand. It's important to test every corner case
43+
you can imagine and report every error you find.
44+
* Create test case to test automatically the diferent functionality of
45+
the software and some error cases. This test cases can be unitary
46+
tests, black box tests, white box tests, ... Basically any type of
47+
test you can tests :).
48+
* Execute the existant automatic tests, report the bugs when found
49+
them or fix the tests if the source code has change and the test is
50+
not valid anymore as is.
51+
52+
The automatic tests are in the tests directory (what a surprise!), and
53+
to execute them you have to run "make tests" in any directory with a
54+
Makefile in it. When you run the tests you can see the results and
55+
errors generated both in the screen and in a file generated in the
56+
tests directory.
57+
58+
To report a bug please visit the project page at github
59+
(https://github.com/i02sopop/coconet), click on the Issues section and
60+
add a new issue. Please, be as descriptive as possible with all the
61+
information you can and add an email address to contact with you if
62+
needed.
63+
64+
Remember that the important thing of the tests are find errors, so
65+
it's important to test both the usual functionality and unusual
66+
situations that never have to happen, and don't feel bad about
67+
discover a bug, remember you are helping the project reporting it.
68+
3769
Donations
3870
===========
3971

72+
Actually we don't have defined a donation method to the project, but
73+
if you want to donate some money or hardware (computers, keyboards,
74+
monitors, ...), please contact <[email protected]> or
75+
<[email protected]>, make your proposal and we find
76+
the way to make the donation.
77+
4078
Translators
4179
=============
4280

81+
TODO
82+
4383
Documenters
4484
=============
4585

86+
TODO
87+
4688
Administrators
4789
================
4890

91+
The project needs administrators to update the website, maintain the
92+
email lists, ... In the repository you can find a document with some
93+
tasks to do by the administrators sorted by difficulty and
94+
priority. If you want to do any of the tasks please keep in touch with
95+
the rest of administrators (ask at <[email protected]>
96+
for them) or write to <[email protected]> in order to coordinate the
97+
tasks.
98+
4999
Developers
50100
============
101+
102+
Coconet is handled in a git repository that you can find in the
103+
github's project page at https://github.com/i02sopop/coconet.
104+
There is a developer mailing list at [email protected]
105+
and a mailing list for the commits at [email protected],
106+
and you can subscribe and access to them at https://lists.ritho.net.
107+
108+
If you want to start collaborating with the project you can see the
109+
TODO file that is in the repository, which is an org file (see emacs
110+
org-mode) with tasks to do with its description, an estimation of its
111+
difficulty, the person to ask about more information about the task
112+
and, in the case, the person which has assigned this task. You can
113+
also check the issues category in the github page to see the bugs
114+
opened about the project.
115+
116+
TODO: Include information about the directory structure at the
117+
repository.

CONTRIBUTE.es

+76-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ del proyecto a cualquier lenguaje en el que no esté disponible, visite
2020
la sección de Traductores en este documento.
2121

2222
Si lo que prefiere es generar o modificar la documentación existente
23-
sobre el proyecto, por favor, visite la sección de Documentadores en
23+
sobre el proyecto, por favor, visite la sección de Documentalistas en
2424
este documento.
2525

2626
Si quieres contribuir en la administración del servidor del proyecto
@@ -38,17 +38,90 @@ favor, contacte con [email protected] exponiendo su idea.
3838
Testers
3939
=========
4040

41+
La parte de tests es una de las partes mas importantes de cualquier
42+
proyecto, ya que es la encargada de que el programa funcione tal y
43+
como se espera de el. Si deseas ayudar al proyecto haciendo tests
44+
puedes continuar por tres vias:
45+
46+
* Probando el programa de todas las maneras que se te ocurran e ir
47+
reportando todos los errores que vayas encontrando.
48+
* Crear casos de prueba que se ejecuten de manera automatica para
49+
probar la distinta funcionalidad del programa. Estos casos de prueba
50+
pueden ser test unitarios, de caja negra, de caja blanca, validacion
51+
de funciones, ... Basicamente cualquier cosa que se te ocurra.
52+
* Ejecutar los tests automaticos que esten hechos e ir reportando
53+
todos los fallos que vayan surgiendo.
54+
55+
Los tests que se ejecutan automaticamente se encuentran dentro del
56+
directorio tests, y para ejecutarlos tienes que ejecutar en cualquiera
57+
de los directorios donde haya un Makefile el comando "make tests",
58+
tras lo cual podras ver la salida generada por los tests y los
59+
posibles errores que se generen tanto en la pantalla como en un
60+
fichero generado en el directorio tests.
61+
62+
Para informar sobre un bug visita la pagina del proyecto en github
63+
(https://github.com/i02sopop/coconet), selecciona la seccion Issues y
64+
selecciona "Create a new issue". Por favor, se tan descriptivo como
65+
puedas, incluye toda la informacion que te sea posible y pon un email
66+
de contacto por si necesitamos ponernos en contacto contigo.
67+
68+
Recuerda que lo importante de los tests es encontrar errores, por lo
69+
que es importante que pruebes desde la funcionalidad habitual hasta
70+
situaciones que en condiciones normales no tendrian que surgir nunca,
71+
y no te sientas mal por descubrir bugs, recuerda que con ello estas
72+
ayudando a mejorar el programa.
73+
4174
Donaciones
4275
============
4376

77+
Actualmente no existe definido un mecanismo de donacion al proyecto,
78+
pero si tienes ganas de aportar algo al proyecto, ya sea de manera
79+
economica como en especia (ordenadores, teclados, monitores, ...), por
80+
favor, ponte en contacto con <palvarez@ritho.net> con tu propuesta y
81+
buscaremos posibles soluciones.
82+
4483
Traductores
4584
=============
4685

47-
Documentadores
48-
================
86+
TODO
87+
88+
Documentalistas
89+
=================
90+
91+
TODO
4992

5093
Administradores
5194
=================
5295

96+
El proyecto necesita administradores que actualicen la web,
97+
administren las listas de correo, ... En el repositorio encontraras un
98+
documento con tareas relacionadas con la administracion ordenadas
99+
tanto de mas facil a mas dificil como de mas a menos urgente. Si
100+
quieres colaborar en la administracion de los servidores para el
101+
proyecto lee dicho documento y, sobretodo, por favor, ponte en
102+
contacto con el resto de administradores (pregunta en
103+
<coconet-developers@lists.ritho.net>) o con <palvarez@ritho.net> para
104+
coordinarte con ellos.
105+
53106
Desarrolladores
54107
=================
108+
109+
El desarrollo de coconet utiliza como sistema de control de versiones
110+
git, cuyo repositorio puedes encontrar en la web del proyecto en
111+
github en https://github.com/i02sopop/coconet. Hay una lista de
112+
desarrolladores en coconet-developers@lists.ritho.net y una lista
113+
donde se envian todos los commits en coconet-commits@lists.ritho.net.
114+
Puedes suscribirte y acceder a estas listas en https://lists.ritho.net.
115+
116+
Si quieres empezar a colaborar en el proyecto puedes revisar el
117+
fichero TODO que esta en el repositorio, el cual es un fichero org
118+
(si no sabes lo que es informate sobre el org-mode de emacs) con
119+
tareas que hay que hacer junto con su descripcion, una estimacion de
120+
su dificultad, la persona que ha incluido la tarea y a la cual le
121+
puede preguntar mas informacion sobre ella y, en su caso, la persona
122+
que tiene asignada esa tarea. Puedes tambien echar un vistazo a la
123+
seccion issues de la pagina del proyecto en github para ver los bugs
124+
que hay abiertos sobre el proyecto.
125+
126+
TODO: Incluir informacion sobre los directorios que hay dentro del
127+
repositorio.

TODO.en

-24
This file was deleted.

TODO.en.org

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
* DONE [#B] [i02sopop] Create the project info structure.
2+
CLOSED: [2012-03-05 lun 01:31]
3+
:PROPERTIES:
4+
:ORDERED: t
5+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
6+
:STYLE: habit
7+
:COOKIE_DATA: todo recursive
8+
:END:
9+
Create the project info structure (AUTHORS, TRANSLATORS, ...).
10+
* TODO Refactorize the source to optimize it and correct bugs.
11+
:PROPERTIES:
12+
:ORDERED: t
13+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
14+
:STYLE: habit
15+
:COOKIE_DATA: todo recursive
16+
:END:
17+
Refactorize the source code to optimize the timing of the program
18+
and to correct bugs.
19+
* TODO Translate code to english
20+
:PROPERTIES:
21+
:ORDERED: t
22+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
23+
:STYLE: habit
24+
:COOKIE_DATA: todo recursive
25+
:END:
26+
Traslate the code to english to facilitate the colaboration of others.
27+
* TODO Improve the documentation
28+
:PROPERTIES:
29+
:ORDERED: t
30+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
31+
:STYLE: habit
32+
:COOKIE_DATA: todo recursive
33+
:END:
34+
Improve the documentation to facilitate the colaboration of others.
35+
* TODO Create a graphical interface.
36+
:PROPERTIES:
37+
:ORDERED: t
38+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
39+
:STYLE: habit
40+
:COOKIE_DATA: todo recursive
41+
:END:
42+
Create a graphical interface to enhace the interacion with the
43+
program.
44+
* TODO Create the web of the project.
45+
:PROPERTIES:
46+
:ORDERED: t
47+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
48+
:STYLE: habit
49+
:COOKIE_DATA: todo recursive
50+
:END:
51+
Create the web of the project in github.
52+
* TODO Finish the INSTALL file.
53+
:PROPERTIES:
54+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
55+
:STYLE: habit
56+
:COOKIE_DATA: todo recursive
57+
:END:
58+
Finish the INSTALL file both in english and in spanish.
59+
60+
61+
62+
* org-mode configuration
63+
#+STARTUP: content
64+
#+STARTUP: overview
65+
#+STARTUP: lognotestate
66+
#+SEQ_TODO: TODO STARTED WAITING DELEGATED APPT | DONE DEFERRED CANCELLED
67+
#+PROPERTY: Effort_ALL 0:10 0:20 0:30 1:00 2:00 4:00 6:00 8:00
68+
#+COLUMNS: %38ITEM(Details) %TAGS(Context) %7TODO(To Do) %5Effort(Time){:} %6CLOCKSUM{Total}

TODO.es

-24
This file was deleted.

TODO.es.org

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
* DONE [#B] Crear la infraestructura de información del proyecto.
2+
CLOSED: [2012-03-05 lun 01:31]
3+
:PROPERTIES:
4+
:ORDERED: t
5+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
6+
:STYLE: habit
7+
:COOKIE_DATA: todo recursive
8+
:END:
9+
Crer la infraestructura de información del proyecto (AUTHORS,
10+
TRANSLATORS, ...).
11+
* TODO Refactorizar el código para optimizarlo y corregir fallos.
12+
:PROPERTIES:
13+
:ORDERED: t
14+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
15+
:STYLE: habit
16+
:COOKIE_DATA: todo recursive
17+
:END:
18+
Refactorizar el código fuente para optimizar los tiempos del
19+
programa y para solucionar errores.
20+
* TODO Traducir el código al inglés.
21+
:PROPERTIES:
22+
:ORDERED: t
23+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
24+
:STYLE: habit
25+
:COOKIE_DATA: todo recursive
26+
:END:
27+
Traducir el código al inglés para facilitar la colaboración de
28+
otras personas.
29+
* TODO Ampliar la documentación
30+
:PROPERTIES:
31+
:ORDERED: t
32+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
33+
:STYLE: habit
34+
:COOKIE_DATA: todo recursive
35+
:END:
36+
Ampliar la documentación para facilitar la colaboración de otras
37+
personas.
38+
* TODO Crear un entorno gráfico.
39+
:PROPERTIES:
40+
:ORDERED: t
41+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
42+
:STYLE: habit
43+
:COOKIE_DATA: todo recursive
44+
:END:
45+
Crear un entorno gráfico para mejorar la interacción con el programa.
46+
* TODO Crear la web del proyecto.
47+
:PROPERTIES:
48+
:ORDERED: t
49+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
50+
:STYLE: habit
51+
:COOKIE_DATA: todo recursive
52+
:END:
53+
Crear la web del proyecto en github.
54+
* TODO Finalizar el fichero INSTALL.
55+
:PROPERTIES:
56+
:LOGGING: TODO(!) STARTED(!) WAITING(!) DELEGATED(!) APPT(!) DONE(!) DEFERRED(!) CANCELLED(!)
57+
:STYLE: habit
58+
:COOKIE_DATA: todo recursive
59+
:END:
60+
Finalizar el fichero INSTALL tanto en castellano como en inglés.
61+
62+
63+
* org-mode configuration
64+
#+STARTUP: content
65+
#+STARTUP: overview
66+
#+STARTUP: lognotestate
67+
#+SEQ_TODO: TODO STARTED WAITING DELEGATED APPT | DONE DEFERRED CANCELLED
68+
#+PROPERTY: Effort_ALL 0:10 0:20 0:30 1:00 2:00 4:00 6:00 8:00
69+
#+COLUMNS: %38ITEM(Details) %TAGS(Context) %7TODO(To Do) %5Effort(Time){:} %6CLOCKSUM{Total}

tests/.gitignore

Whitespace-only changes.

0 commit comments

Comments
 (0)