Recomendaciones a momento de publicar.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

Recomendaciones

Las publicaciones de Acid Labs tienen como objetivo integrarnos como equipo a la comunidad de desarrolladores de código abierto con el fin de aprender, compartir conocimiento y ganar visibilidad como empresa.

Indispensables

README

Es indispensable que todo proyecto publicado tenga un README en el que se describa el proyecto, su uso y se mencionen los copyrights y licencias a los que está sometido.

Se recomienda escribirlo antes de comenzar el proyecto cuando están todas las ganas para hacerlo. Además, eso ayuda a mantener los objetivos claros a lo largo del desarrollo.

LICENSE.txt

La licencia en texto plano (LICENSE.txt). Se recomienda usar la GLPv3, o eventualmente la licencia X11 (conocida como licencia MIT).

El README debe comportar una sección License en la que se reproduzca el disclaimer correspondiente a la licencia (ver el disclaimer de la GPLv3).

Copyrights

Legalmente, quienes poseen el copyright son quienes tienen derecho a decidir sobre la licencia bajo la cual se publica algo. Es necesario mencionar los copyrights de Acid Labs y de los autores y autoras en la sección License del README y donde sea necesario de la siguiente forma:

Copyright (C) 2011-2013 Acid Labs
Copyright (C) 2011 Carlos Gardel
Copyright (C) 2011-2013 Antonia López Quiroga

Fuertemente recomendados

Travis-ci

Travis-ci es un servicio de integración contínua de código libre. Es gratuito, está integrado con Github.

Trabajar con Travis-ci es sencillo, así se usaría para agregarle funcionalidad a la gema tbk-rails:

  1. Crear el branch feature-bootstrap-option-for-views-generator
  2. Desarrollar ejecutando los test relativos a los generadores de vistas.
  3. Una vez que la funcionalidad está completa, subir el branch a Github: git push -u origin feature-bootstrap-option-for-views-generator para gatillar Travis-ci
  4. Travis informa automáticamente en cuanto haya terminado de correr la suite de tests entera
  5. Si el resultado es positivo se puede hacer el merge de feature-bootstrap-option-for-views-generator en master

Sugeridos

Para Ruby: Code Climate

Code Climate es un servicio (gratuito para proyectos open-source) que inspecciona código en Ruby en busqueda de repeticiones, code smells e identifica áreas candidatas para refatorizar. Tal como Travis-ci, tiene muy buena integración con Github.