Guía de contribución a FacturaScripts
O guia de cómo aportar código y plugins al proyecto:

FacturaScripts se compone de un núcleo, una serie de plugins principales (facturacion_base, presupuestos_y_pedidos, servicios...) y todos los demás plugins. Cuanto más importante o popular es un plugin, mayores son las restricciones a la hora de aportar cambios, pues un problema en estos plugins puede afectar a miles de usuarios.

Tu plugin es tu castillo

En tus plugins tienes libertad para añadir y quitar todo lo que quieras, faltaría más. Eso si, si de verdad quieres contribuir, no olvides enviar tu plugin, en la sección plugins de esta web.

De la misma forma que tu plugin es tu castillo, el plugin de otro usuario, es su castillo. Respeta el rumbo y el plan de desarrollo de cada plugin y no quieras imponer tus cambios. Puedes modificar o sustituir cualquier clase en tu plugin, no necesitas modificar el núcleo ni los plugins originales. Comparte, seduce, no impongas.

Solamente quiero contribuir con sugerencias, nada de programar

Si no quieres programar nada, tienes la sección ideas de la comunidad. Escribe tus ideas y no olvides votarlas y promocionarlas. Los programadores se fijan en las más votadas. Si una idea no tiene votos, o tiene muy pocos votos, es que no es interesante.

Quiero contribuir cambios en el plugin de otro ¿Qué hago?

Lo primero que debes hacer es ponerte en contacto con ese programador. Ve a la sección comunidad -> Escribir, selecciona el plugin y coméntale al programador:
- Qué quieres añadir/modificar.
- Por qué quieres hacerlo. Tú sabes por qué haces lo que haces, pero un tercero no tiene por qué saberlo, ni por qué verlo de la misma manera. Ningún programador te aceptará un cambio sin un motivo.

Si el programador está de acuerdo:
- Ve al repositorio github del plugin. Lo puedes encontrar en la web del plugin, haciendo clic en descargar -> código fuente.
- Haz clic en fork, para tener una copia tuya para poder modificar.
- Haz los cambios en esa copia.
- Prueba que de verdad funcione, tanto con datos como con una base de datos vacía.
- Desde tu repositorio github, pulsa create new pull-request para enviar los cambios al programador.

Si el programador no está de acuerdo y el plugin es software libre:
- Crea un nuevo plugin con las partes del plugin que quieras modificar: los modelos, controladores, vistas y archivos js que quieras cambiar.
- Añade al facturascripts.ini un require = 'plugin_que_modificas'
- Sube todo el código a github y compártelo desde plugins -> enviar.

Si el programador no está de acuerdo y el plugin no es software libre:
- Mala suerte. No puedes modificar código que no te pertenece o cuya licencia no es software libre.
- Crea un nuevo plugin desde cero.

Plugins principales

Los plugins principales son facturacion_base, presupuestos_y_pedidos y servicios. Estos plugins son usados por miles de personas cada día y su estabilidad debe ser máxima. Por este motivo solamente se admiten contribuciones que cumplan estos requisitos:
- El objetivo del nuevo código debe ser: resolver un bug o añadir una funcionalidad solicitada (en la sección tareas de la comunidad).
- El código debe seguir las normas de estilo generales de FacturaScripts.
- El código debe haber sido probado tanto con datos como con bases de datos vacías, tanto en MySQL como en PostgreSQL.
- No debe añadir ninguna librería PHP, Javascript o nuevas reglas CSS, a menos que haya sido autorizado por el programador principal del plugin.
- El envío de código se debe hacer mediante un pull-request al repositorio de github.

El núcleo

Se encarga de la gestión de plugins, páginas, usuarios y roles de usuarios. Además de ser el propio framework sobre el que se construye el resto. El código fuente está alojado en github:
https://github.com/NeoRazorX/facturascripts_2015

Debido a que es la parte más sensible del proyecto, solamente se admiten contribuciones que cumplan estos requisitos:
- El objetivo del nuevo código debe ser: resolver un bug o añadir una funcionalidad solicitada (en la sección tareas de la comunidad).
- El código debe seguir las normas de estilo generales de FacturaScripts.
- El código debe haber sido probado, tanto con datos como con bases de datos vacías, tanto en MySQL como en PostgreSQL.
- No debe añadir ninguna librería PHP, Javascript o nuevas reglas CSS, a menos que haya sido autorizado por el programador principal.
- El envío de código se debe hacer mediante un pull-request al repositorio de github.

Normas de estilo generales de FacturaScripts

- El código debe ser PHP 5.3 ¿Por qué? Porque todavía es la única opción en miles de hostings. Si lo cambiásemos dejaríamos fuera a miles de usuarios. Cuando se reduzca su uso se elevará este requisito.
- La tabulación será de 3 espacios.
- Tanto los nombres de variables como de funciones deben seguir el estilo de palabras en minúsculas separadas por guiones bajos, ejemplos: $mi_variable, mi_funcion()
- Tanto ifs como for y foreach deben tener las llaves en lineas separadas. Ejemplos:
if ($mi_variable == 1) {
   /// hago algo
}
- Puedes formatear automáticamente el código php en netbeans pulsando ALT+SHIFT+F. No lo hagas con los archivos html, genera problemas.
 NeoRazorX ES   08-03-2017 00:24:37  





Tu email:



Soporte:

FacturaScripts es software libre y gratuito, pero si lo que busca es asesoramiento y soporte profesional, use la sección soporte.

  Soporte

¿Desea ser distribuidor?

Si desa ser distribuidor oficial de FacturaScripts, comience hoy mismo el proceso.

  hágase partner

Redes sociales:

Puede encontrarnos en las principales redes sociales. Y también en google+.





© 2013-2017 FacturaScripts