Skip to content

Manual básico de supervivencia para colaborar con el sitio de PyMX

Alexandro Colorado edited this page Apr 29, 2015 · 1 revision

Inquietud:

Soy nuevo, quiero colaborar pero nunca trabajé en equipo, menos con github!

Respuesta:

Bienvenido y muchas gracias por querer contribuir! No hay problema, los pasos que debes seguir son:

  1. 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.

  2. Comenta la tarea que has escogido diciendo que tu seras la heroica persona en llevar a cabo la misión.

  3. 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 .

  4. Una vez que termines con tu tarea, commitea, pushea y crea un pull request! :)

  5. Si tenes problemas usando github, no dudes en preguntar en la lista o pedir ayuda por IRC.


Inquietud:

Pusieron reglas respecto de como 'programar'? Ej, idioma de las variables, comentarios, etc ...

Respuesta:

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.


Inquietud:

Hay alguna 'normalización' respect de como escribir las urls en el archivo urls.py?

Respuesta:

Sí, las reglas son como ejemplo, para una app de 'news':

  • Para listar todas las noticias: /news

  • Para agregar una nueva noticia: /news/add

  • Para editar una noticia: /news/:id/edit

  • Para borrar una noticia: /news/:id/delete


Inquietud:

Funciona el sitio con <= Python 2.7?

Respuesta:

NO


Inquietud:

Funciona el sitio con >= Python 3.3?

Respuesta:

SI! :D


Inquietud:

Como arranco / instalo el proyecto en mi máquina?

Respuesta:

  1. Asegurese de tener >= Python 3.3 instalado

  2. Debe crear un nuevo entorno virtual, ej: pyvenv ~/.virtualenvs/pymxweb

  3. Activar tu entorno, ej: source ~/.virtualenvs/pymxweb/bin/activate

  4. Clonar el repo y trabajar en TU branch

  5. instalar las dependencias, ej: pip install -r ./requirements.txt

  6. python manage.py syncdb

  7. python manage.py runserver

  8. Visitar con tu browser http://localhost:8000 y listo!