-
Notifications
You must be signed in to change notification settings - Fork 100
Manual básico de supervivencia para colaborar con el sitio de PyAr
Soy nuevo, quiero colaborar pero nunca trabajé en equipo, menos con github!
Bienvenido y muchas gracias por querer contribuir! No hay problema, los pasos que debes seguir son:
-
Escoge una tarea que creas puedes hacer del 'issue tracker': https://github.com/samuelbustamante/pyarweb/issues . Vas a ver que están clasificadas por el tipo de tarea que es (programación, html, css, etc) y un estimado de cuan 'dificil' es la tarea.
-
Comenta la tarea que has escogido diciendo que tu seras la heroica persona en llevar a cabo la misión.
-
Crea un branch del repo, y su nombre debe ser de la forma: issue_numero_de_la_tarea, ej: issue_26. Si no sabes como crear un branch, aquí lo tienes detallado: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository .
-
Una vez que termines con tu tarea, commitea, pushea y crea un pull request! :)
-
Si tenes problemas usando github, no dudes en preguntar en la lista o pedir ayuda por IRC.
Pusieron reglas respecto de como 'programar'? Ej, idioma de las variables, comentarios, etc ...
Sí, y son las siguientes:
-
El código debe ser pep8 válido. Recomendamos IDEs como Ninja-Ide o fisa-vim que pueden ayudarte a escribir código y marcarte cuando no estas cumpliendo pep8.
-
Los nombres de variables comentarios y docstrings son en ingles.
-
Los docstrings tienen que ser de la forma """This is a docstring.""" osea, comenzar con mayúscula y terminar con un '.' al final. Casos como: """ this is a docstring.""" o """this is a docstring.""" o """This is a docstring""" no son válidos.
-
No usar tabulador, configurar la identación a 4 espacios.
Como arranco / instalo el proyecto en mi máquina?
Debes tener instalado virtualenvwrapper y:
-
Crear un nuevo environment, ej: mkvirtualenv pyarweb
-
Clonar el repo y trabajar en TU branch
-
instalar las dependencias, ej: pip install -r ./requirements.txt
-
python manage.py syncdb
-
python manage.py runserver
-
Visitar con tu browser http://localhost:8000 y listo!