From 3cd3adcb1983e8e8f7e3c9c098f09629bbba997b Mon Sep 17 00:00:00 2001 From: kikito Date: Thu, 30 Jul 2015 17:41:14 +0200 Subject: [PATCH 1/3] Adds initial README. Fixes #58 --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.rdoc | 28 ---------------------------- 2 files changed, 45 insertions(+), 28 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 000000000..648cefd8d --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Aplicación de Participación Ciudadana del Ayuntamiento de Madrid + +Este es el repositorio de código abierto de la Aplicación de Participación Ciudadana del Ayuntamiento de Madrid. + +## Estado del proyecto + +El desarrollo de esta aplicación comenzó el [15 de Julio de 2015](https://github.com/AyuntamientoMadrid/participacion/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6) + +Este proyecto está en las primeras fases de su desarrollo. Las funcionalidades actualmente presentes en el código, así como sus nombres, deben considerarse como provisionales. + +## Tecnología + +El backend de esta aplicación se desarrolla con el lenguaje de programación [Ruby](https://www.ruby-lang.org/) sobre el *framework* [Ruby on Rails](http://rubyonrails.org/). +Las herramientas utilizadas para el frontend no están cerradas aún. Los estilos de la página usan [SCSS](http://sass-lang.com/) sobre [Foundation](http://foundation.zurb.com/) + +## Configuración para desarrollo y tests + +Prerequisitos: tener instalado git, Ruby 2.2.2, la gema `bundler`, y una librería moderna de PostgreSQL. + +``` +cd participacion +bundle install +cp config/database.yml.example config/database.yml +cp config/secrets.yml.example config/secrets.yml +bundle exec bin/rake db:create db:schema_load +RAILS_ENV=test bundle exec rake db:create db:schema_load +``` + +Para ejecutar la aplicación en local: +``` +bundle exec bin/rails s +``` + +Para ejecutar los tests: +``` +bundle exec bin/rspec +``` + +## Licencia + +El código de este proyecto está publicado bajo la licencia MIT (ver MIT-license.md) + +## Contribuciones + +Ver fichero CONTRIBUTING.md diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e22..000000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app. From 250358bcaf87c6edf96765ccffb598a1c3dedbd4 Mon Sep 17 00:00:00 2001 From: kikito Date: Thu, 30 Jul 2015 17:41:25 +0200 Subject: [PATCH 2/3] Adds CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..79a89b919 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +## Miembros del equipo + +* Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000) +* Juanjo Bazán [github](https://github.com/xuanxu) | [twitter](https://twitter.com/xuanxu) +* Enrique García Cota [github](https://github.com/kikito) | [twitter](https://twitter.com/otikik) +* Alberto Garcia Cabeza [github](https://github.com/decabeza) | [twitter](https://twitter.com/decabeza) + +## Comunicación general y de incidencias + +El método preferido para informar sobre una incidencia en el proyecto es [creando una incidencia en la cuenta de Github del proyecto](https://github.com/AyuntamientoMadrid/participacion/issues/new). + +Para comunicación más puntual e informal, contacta con los miembros del equipo por twitter. + +## Resolver una incidencia + +Cuando quieras resolver una incidencia mediante código: + +* Avisa de que vas a trabajar en esta incidencia añadiendo un comentario +* Haz un fork del proyecto +* Crea una rama para resolver la incidencia desde la rama `master` +* Añade el código necesario para resolver la incidencia en tantos commits como sea preciso +* Asegúrate de que los tests pasan (y escribe más tests para probar la nueva funcionalidad si fuera preciso) +* Envía una *pull request* al repositorio principal indicando que la incidencia que se está arreglando + +## Otras formas de contribuir sin código + +* Si crees que hay una funcionalidad que hace falta, o descubres un problema, abre una incidencia (asegúrate de que + no haya una incidencia para ya abierta antes) +* También puedes ayudar dando este proyecto a conocer + +## Cómo escribir una incidencia + +* Trata de darle un título descriptivo (algo más que "xxx no funciona"). +* Es buena idea incluir las siguientes secciones: + * Pasos que se han realizado para producir la incidencia + * Lo que se esperaba que pasara + * Lo que ha pasado +* También es buena idea que incluyas tu sistema operativo, navegador, versión de navegador y plugins instalados. From 8141acafc29c4b0829f24ce9ebad4d4a54a428ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juanjo=20Baz=C3=A1n?= Date: Thu, 30 Jul 2015 17:51:08 +0200 Subject: [PATCH 3/3] typos --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79a89b919..f06f5b703 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,12 @@ Cuando quieras resolver una incidencia mediante código: * Crea una rama para resolver la incidencia desde la rama `master` * Añade el código necesario para resolver la incidencia en tantos commits como sea preciso * Asegúrate de que los tests pasan (y escribe más tests para probar la nueva funcionalidad si fuera preciso) -* Envía una *pull request* al repositorio principal indicando que la incidencia que se está arreglando +* Envía una *pull request* al repositorio principal indicando la incidencia que se está arreglando ## Otras formas de contribuir sin código * Si crees que hay una funcionalidad que hace falta, o descubres un problema, abre una incidencia (asegúrate de que - no haya una incidencia para ya abierta antes) + no haya una incidencia para lo mismo ya abierta antes) * También puedes ayudar dando este proyecto a conocer ## Cómo escribir una incidencia