Introducción
Puedes modificar Consul Democracy y adaptarlo a la imagen y a la manera de trabajar de tu institución. Para esto, debes primero crear tu propio "fork".
La principal regla a seguir al personalizar código de Consul Democracy es hacerlo de manera que los cambios personalizados estén separados del resto del código. De esta forma, al actualizar a una nueva versión de Consul Democracy, será más fácil comprobar qué código pertenece a la aplicación y cómo cambia el código en la nueva versión. En caso contrario, será muy difícil adaptar tus cambios personalizados a la nueva versión.
Con este fin, Consul Democracy incluye directorios "custom" para que rara vez tengas que cambiar los archivos originales.
Ficheros y directorios especiales
Para adaptar tu "fork" de Consul Democracy, puedes utilizar alguno de los directorios custom que están en las rutas:
app/assets/images/custom/app/assets/javascripts/custom/app/assets/stylesheets/custom/app/components/custom/app/controllers/custom/app/form_builders/custom/app/graphql/custom/app/lib/custom/app/mailers/custom/app/models/custom/app/models/custom/concerns/app/views/custom/config/locales/custom/spec/components/custom/spec/controllers/custom/spec/models/custom/spec/routing/custom/spec/system/custom/
Aparte de estos directorios, también puedes utilizar los siguientes ficheros:
app/assets/javascripts/custom.jsapp/assets/stylesheets/custom.cssapp/assets/stylesheets/_custom_settings.cssapp/assets/stylesheets/_consul_custom_overrides.cssconfig/application_custom.rbconfig/environments/custom/development.rbconfig/environments/custom/preproduction.rbconfig/environments/custom/production.rbconfig/environments/custom/staging.rbconfig/environments/custom/test.rbconfig/routes/custom.rbGemfile_custom
Utilizando estos ficheros, podrás personalizar traducciones, imágenes, CSS, JavaScript, vistas HTML, cualquier código de Ruby como modelos, controladores, componentes u otras clases de Ruby, gemas, configuración de la aplicación, rutas y tests.
Ejecutar los tests
Al personalizar el código, es muy importante que todos los tests de la aplicación sigan pasando. En caso contrario, habrá fallos al actualizar a una nueva versión de Consul Democracy (o incluso al actualizar los cambios personalizados) y estos fallos no serán detectados hasta que el código esté ya ejecutándose en producción. Consul Democracy incluye más de 6000 tests que comprueban la manera en que se comporta la aplicación; sin ellos, sería imposible asegurarse de que el código nuevo no rompe comportamientos existentes.
Así que, en primer lugar, asegúrate de haber configurado tu "fork" para que utilice un sistema de integración continua que ejecute todos los tests cada vez que hagas cambios en el código. Recomendamos ejecutar estos tests en una rama de desarrollo abriendo una "pull request" (también llamada "merge request") para que los tests se ejecuten antes de que los cambios personalizados se añadan a la rama master.
En caso de que alguno de los tests falle, echa un vistazo a uno de los tests y comprueba si falla por un fallo en el código personalizado o porque el test comprueba un comportamiento que ha cambiado con los cambios personalizados (por ejemplo, puede que modifiques el código para que solamente los usuarios verificados puedan añadir comentarios, pero puede que haya un test que compruebe que cualquier usuario puede añadir comentarios, ya que es el comportamiento por defecto). Si el test falla debido a un fallo en el código personalizado, arréglalo ;). Si falla debido a un comportamiento que ha cambiado, consulta la sección de personalización de tests.
Recomendamos encarecidamente añadir tests a tus cambios personalizados para que tengas una forma de comprobar si estos cambios siguen funcionando cuando actualices a una nueva versión de Consul Democracy.
Last updated