Merge pull request #115 from AyuntamientoMadrid/readme-en

Adds english lang README & CONTRIBUTING files
This commit is contained in:
Raimond Garcia
2015-08-07 16:02:25 +02:00
4 changed files with 102 additions and 3 deletions

View File

@@ -43,3 +43,5 @@ Cuando quieras resolver una incidencia mediante código:
* 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.
¡Gracias! :heart: :heart: :heart:

46
CONTRIBUTING_EN.md Normal file
View File

@@ -0,0 +1,46 @@
## Team members
* 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)
## Report an issue
The prefered way to report any bug is [opening an issue in the project's Github repo](https://github.com/AyuntamientoMadrid/participacion/issues/new).
For more informal communication, contact team members via twitter
## Resolve an issue
Admins tag issues using two label related with collaboration availability:
* `PRs-welcome`: [issues labeled with PRs-welcome](https://github.com/AyuntamientoMadrid/participacion/labels/PRs-welcome) are well defined features ready to be implemented by whoever wants to do it.
* `Not-ready`: with this label admins mark features or changes that are not well defined yet or subject to an internal decision. Is not a good idea to start implementation of these isuues.
If you want to contribute code to solve an issue:
* Add a comment to tell everyone you are working on the issue.
* If an issue has someone assigned it means that person is already working on it.
* Fork the project.
* Create a topic branch based on master.
* Commit there your code to solve the issue.
* Make sure all test are passing (and add specs to test any new feature if needed).
* Open a *pull request* to the main repository describing what issue you are addressing.
## Other ways of contributing without coding
* If you think there's a feature missing, or find a bug, create an issue (make sure it has not already been reported).
* You can also help promoting the project talking about it in your social networks.
## How to report an issue
* Try to use a descriptive and to-the-point title
* Is a good idea to include some of there sections:
* Steps to reproduce the bug
* Expected behaviour/response
* Actual response
* Sometimes it is also helpful if you mention your operating system, browser version and installed plugins.
Thanks! :heart: :heart: :heart:

View File

@@ -27,8 +27,8 @@ 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
bundle exec bin/rake db:setup
RAILS_ENV=test bundle exec rake db:setup
```
Para ejecutar la aplicación en local:
@@ -47,4 +47,4 @@ El código de este proyecto está publicado bajo la licencia MIT (ver MIT-licens
## Contribuciones
Ver fichero CONTRIBUTING.md
Ver fichero [CONTRIBUTING.md](CONTRIBUTING.md)

51
README_EN.md Normal file
View File

@@ -0,0 +1,51 @@
# Ayuntamiento de Madrid (Madrid city's government) eParticipation application
[![Build Status](https://travis-ci.org/AyuntamientoMadrid/participacion.svg?branch=master)](https://travis-ci.org/AyuntamientoMadrid/participacion)
[![Code Climate](https://codeclimate.com/github/AyuntamientoMadrid/participacion/badges/gpa.svg)](https://codeclimate.com/github/AyuntamientoMadrid/participacion)
[![Dependency Status](https://gemnasium.com/AyuntamientoMadrid/participacion.svg)](https://gemnasium.com/AyuntamientoMadrid/participacion)
[![Coverage Status](https://coveralls.io/repos/AyuntamientoMadrid/participacion/badge.svg?branch=master&service=github)](https://coveralls.io/github/AyuntamientoMadrid/participacion?branch=master)
This is the opensource code repository of Madrid City government eParticipation website
## Current state
Development started on [2015 July 15th](https://github.com/AyuntamientoMadrid/participacion/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6)
The project is in its early stages. Features currently present in the code (and their names) are subject to change.
## Tech stack
The application backend is written in the [Ruby language](https://www.ruby-lang.org/) using the [Ruby on Rails](http://rubyonrails.org/) framework.
Frontend tools used include [SCSS](http://sass-lang.com/) over [Foundation](http://foundation.zurb.com/) for the styles.
## Configuration for development and test environments
Prerequisites: install git, Ruby 2.2.2, bundler gem and 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:setup
RAILS_ENV=test bundle exec rake db:setup
```
Run the app locally:
```
bundle exec bin/rails s
```
Run the tests with:
```
bundle exec bin/rspec
```
## Licence
Code published under MIT license (see [MIT-license.md](MIT-license.md))
## Contributions
See [CONTRIBUTING_EN.md](CONTRIBUTING_EN.md)