¿Interesado en retribuir un poco a la comunidad? Quizás ha encontrado un fallo en Django que le gustaría ver solucionado, o quizás hay una pequeña característica que quiera agregar.
\nContribuyendo al propio proyecto de Django es la mejor forma de ver sus propios problemas abordados. Puede parecer desalentador al inicio, pero es un camino ya conocido: con documentación, herramientas, y una comunidad que le ayudará. Le guiaremos por todo el proceso, así pueda aprender con el ejemplo.
\nPara este tutorial, esperamos que comprenda al menos el funcionamiento básico de Django. Esto significa que usted no tendría problemas estudiando los tutoriales existentes para crear su primera aplicación Django. Adicionalmente, debería tener una buena comprensión de Python. Si no es así, Dive into Python es un libro fantástico (y gratuito) disponible en línea para los programadores que comienzan en Python.
\nAquellos de ustedes que no están familiarizados con los sistemas de control de versiones y Trac encontrarán que este tutorial y sus vínculos incluyen información suficiente para empezar. Sin embargo, es probable que quiera leer un poco más acerca de estas diferentes herramientas si usted planea contribuir a Django con regularidad.
\nSin embargo, en su mayor parte, este tutorial trata de explicar tanto como sea posible, de modo que pueda ser de utilidad para la audiencia más amplia.
\n\nLe mostraremos cómo contribuir con parches para Django por primera vez. Al final de este tutorial, contará con un entendimiento básico sobre las herramientas y procesos implicados. Específicamente, cubriremos lo siguiente:
\nInstalando Git.
Descargue una copia de la versión de desarrollo de Django
Conjunto de pruebas de funcionamiento de Django.
Escribiendo una prueba para su parche.
Escribiendo el código para su parche.
Probando su parche.
Enviar una solicitud de pull.
Dónde buscar más información.
Una vez que haya terminado el tutorial, puede revisar el resto de la documentación para contribuir con Django. Contiene una gran cantidad de información de lectura obligatoria para todo el que desee convertirse en colaborador habitual de Django. Si tiene preguntas, es probable que obtenga las respuestas.
\n\n\nComo un colaborador, usted puede ayudarnos a mantener abierta e inclusiva la comunidad Django. Por favor lea y siga nuestro Código de conducta.
\nPara este tutorial, necesitará instalar Git para descargar la versión actual de desarrollo de Django y generar archivos de revisión de los cambios que realice.
\nPara revisar si tiene o no instalado Git , ejecute git en la línea de comandos. Si recibe un mensaje diciendo que el comando no pudo ser encontrado, tendrá que descargarlo e instalarlo. Consulte la página de descarga de Git.
Si no está familiarizado con Git, siempre se puede encontrar más información sobre sus comandos (una vez instalado) escribiendo git help en la línea de comandos.
El primer paso para contribuir con Django es obtener una copia del código fuente. Primero, haga un fork de Django en GitHub. Después, desde la línea de comandos, use el comando cd para navegar hasta el directorio donde quiera que se aloje su copia local de Django.
Descargue el repositorio de código fuente de Django con el siguiente comando:
\nLinux / macOS
$ git clone https://github.com/YourGitHubName/django.git\nWindows
...\\> git clone https://github.com/YourGitHubName/django.git\nAhora que tiene una copia local de Django, puede instalarla como si fuera a instalar cualquier paquete utilizando pip. La forma más conveniente de hacerlo es mediante un entorno virtual, que es una función incorporada en Python que le permite mantener un directorio separado de paquetes instalados para cada uno de sus proyectos para que no interfieran entre sí.
Es una buena idea mantener todos sus entornos virtuales en un solo lugar, por ejemplo, en `` virtualenvs /`` en su directorio de inicio.
\nCree un nuevo entorno virtual ejecutando:
\nLinux / macOS
$ python3 -m venv ~/.virtualenvs/djangodev\nWindows
...\\> py -m venv %HOMEPATH%\\.virtualenvs\\djangodev\nLa ruta es donde se guardará el nuevo entorno en su computadora.
\nEl último paso para configurar su entorno virtual es activarlo:
\n$ source ~/.virtualenvs/djangodev/bin/activate\nSi el comando source no está disponible, puede intentar usar un punto en su lugar:
$ . ~/.virtualenvs/djangodev/bin/activate\nDebe activar el entorno virtual cada vez que abra una nueva ventana de la terminal.
\n\nEl nombre del entorno virtual actualmente activado se muestra en la línea de comandos para ayudarlo a realizar un seguimiento de cuál está utilizando. Todo lo que instale a través de pip mientras se muestre este nombre se instalará en ese entorno virtual, aislado de otros entornos y paquetes del sistema.
Continúe e instale la copia previamente clonada de Django:
\nLinux / macOS
$ python -m pip install -e /path/to/your/local/clone/django/\nWindows
...\\> py -m pip install -e \\path\\to\\your\\local\\clone\\django\\\nLa versión instalada de Django ahora está apuntando a tu copia local al instalarla en modo editable. Verás inmediatamente cualquier cambio que hagas en ella, lo cual es de gran ayuda al escribir tu primer parche.
\nIt may be helpful to test your local changes with a Django project. First you\nhave to create a new virtual environment, install the previously cloned\nlocal copy of Django in editable mode,\nand create a new Django project outside of your local copy of Django. You will\nimmediately see any changes you make to Django in your new project, which is\nof great help when writing your first patch, especially if testing any changes\nto the UI.
\nYou can follow the tutorial for help in creating a\nDjango project.
\nAl contribuir a Django es muy importante que los cambios de tu código no introduzcan errores en otras áreas de Django. Una forma de comprobar que Django sigue funcionando después de hacer tus cambios es ejecutar el conjunto de pruebas de Django. Si todas las pruebas aún pasan, entonces puedes estar razonablemente seguro de que tus cambios funcionan y no han roto otras partes de Django. Si nunca has ejecutado el conjunto de pruebas de Django antes, es una buena idea ejecutarlo una vez antes para familiarizarte con su salida.
\nPara ejecutar tu código, cambia al directorio Django tests/ con cd tests, e instala las eventuales dependencias necesarias ejecutando:
Linux / macOS
$ python -m pip install -r requirements/py3.txt\nWindows
...\\> py -m pip install -r requirements\\py3.txt\nSi encuentra un error durante la instalación, es posible que a su sistema le falte una dependencia para uno o más de los paquetes de Python. Consulte la documentación del paquete que falla o busque en la web el mensaje de error que encuentre.
\nAhora estamos listos para ejecutar el conjunto de pruebas. Si estás utilizando GNU/Linux, macOS o alguna otra distribución de Unix, ejecute:
\nLinux / macOS
$ ./runtests.py\nWindows
...\\> runtests.py \nAhora siéntate y relájate. Django tiene una enorme batería de pruebas que verificarán tu código. Esto llevará algunos minutos, dependiendo de la velocidad de tu ordenador.
\nMientras se ejecuta la suite de pruebas de Django, verá una secuencia de caracteres que representan el estado de cada prueba a medida que se completa. `` E`` indica que un error se planteó durante una prueba, y `` F`` indica las afirmaciones de una prueba fallida. Ambos de estos son considerados como fallas de prueba. Mientras tanto, `` x`` y `` s`` indican fallas esperadas y pruebas omitidas, respectivamente. Los puntos indican pruebas superadas.
\nLas pruebas omitidas se deben usualmente a la ausencia de bibliotecas externas requeridas para la ejecución de las pruebas; ver Running all the tests para la lista de dependencias y estar seguro de instalar aquellas relacionadas con los cambios que está haciendo (no necesitamos ninguna para esta tutorial). Algunas pruebas son especificas de un backend de base de datos particular y serán omitidas si no se está probando ese backend. SQLite es el backend por defecto para las pruebas. Para ejecutar las pruebas con un backend diferente ver Using another settings module.
\nUna vez que las pruebas finalicen, usted debe ser recibido con un mensaje que le informa si el conjunto de pruebas pasó o falló. Dado que aún no ha realizado ningún cambio en el código de Django, todo el conjunto de pruebas debe pasar. Si obtiene fallos o errores asegúrese de que ha seguido correctamente todos los pasos anteriores . Consulte: ref: Ejecutar pruebas unitarias para más información.
\nTen en cuenta que la última rama «main» de Django no siempre es estable. Cuando desarrolles contra «main», puedes comprobar Django’s continuous integration builds para determinar si los fallos son específicos de tu máquina o si también están presentes en las builds oficiales de Django. Si haces clic para ver una compilación en particular, verás la «Matriz de configuración» que muestra los fallos desglosados por versión de Python y backend de base de datos específicos.
\n\nPara este tutorial, trabajaremos sobre un «falso ticket» como un caso de estudio. Estos son los detalles imaginarios:
\n\nBueno, ahora implemente la característica y sus pruebas asociadas.
\nAntes de hacer algún cambio, cree una nueva rama para el ticket:
\nLinux / macOS
$ git checkout -b ticket_99999\nWindows
...\\> git checkout -b ticket_99999\nPuede elegir cualquier nombre que desee para la rama, por ejemplo «ticket_99999». Todos los cambios realizados en esta rama será específico para el ticket y no afecta la copia principal del código previamente clonado
\nEn la mayoría de los casos, para que un parche sea aceptado en Django tiene que incluir pruebas. Para los parches de corrección de bugs, esto significa escribir una prueba de regresión para asegurar que el bug no sea reintroducido en Django más adelante. Una prueba de regresión debe ser escrita de forma tal que falle mientras que todavía exista el bug y pase una vez que el bug se haya corregido. Para los parches que contienen nuevas características, tendrás que incluir pruebas que garanticen que dichas características estén funcionando correctamente. Los parches también deben fallar cuando la nueva característica no esté presente y por lo tanto, pasar una vez que haya sido aplicada.
\nUna buena forma de hacer esto, es escribir primero sus nuevas pruebas antes de realizar cualquier cambio en el código. Este estilo de desarrollo se llama desarrollo guiado por pruebas y se puede aplicar tanto a proyectos completos como a parches individuales. Después de escribir sus pruebas, ejecútelas para asegurarse de que en efecto fallan (ya que aún no ha corregido ese bug o añadido esa característica). Si sus nuevas pruebas no fallan, tendrá que arreglarlas de manera que lo hagan. Después de todo, una prueba de regresión que pasa sin importar si un error está presente, no es muy útil en prevenir que ese error se repita en el futuro.
\nAhora a nuestro ejemplo práctico.
\nPara resolver este problema, vamos a añadir una función make_toast() al módulo django.shortcuts. Primero vamos a escribir un test que intente usar la función y comprobar que su salida parezca correcta.
Navegue a la carpeta tests/shortcuts/ y cree un nuevo fichero llamado test_make_toast.py. Añada el siguiente código:
from django.shortcuts import make_toast\nfrom django.test import SimpleTestCase\n\n\nclass MakeToastTests(SimpleTestCase):\n def test_make_toast(self):\n self.assertEqual(make_toast(), "toast")\nEsta prueba comprueba que la función make_toast() devuelve 'toast'
Como todavía no hemos hecho ninguna modificación en django.shortcuts, nuestro test debería fallar. Vamos a ejecutar todas las pruebas en la carpeta shortcuts para asegurarnos de que es lo que realmente ocurre. Usa cd para cambiarte al directorio tests/ de Django y ejecuta:
Linux / macOS
$ ./runtests.py shortcuts\nWindows
...\\> runtests.py shortcuts\nSí los tests han corrido correctamente, deberías obtener un error vinculado al método que hemos agradado, con éste error:
\nImportError: cannot import name 'make_toast' from 'django.shortcuts'\nSi todas las pruebas pasaron, entonces deberías verificar que la nueva prueba mostrada arriba esté en la carpeta adecuada y tenga nombre de archivo apropiado.
\nAhora agregaremos la función make_toast().
Navegue al directorio django/ y edite shortcuts.py. Al final del archivo añada:
def make_toast():\n return "toast"\nEs necesario ahora asegurarnos que el test que hemos escrito funciona correctamente. De nuevo, navega al directorio tests/ de Django y ejecuta:
Linux / macOS
$ ./runtests.py shortcuts\nWindows
...\\> runtests.py shortcuts\nTodo debería funcionar bien. En caso contrario, asegúrate que la función está en el archivo correcto.
\nUna vez que hayas verificado que el parche y el test están funcionando correctamente, es una buena idea ejecutar toda la batería de tests de Django para verificar que tus modificaciones no ha introducido errores en otras áreas de Django. Aunque todos los tests Django pasen exitosamente no garantiza que tu código esté libre de errores, ayuda a identificar muchos errores y regresiones que de otro modo podrían pasar desapercibidos.
\nPara ejecutar todo el conjunto de pruebas de Django, cambie al directorio tests/ de Django y ejecute:
Linux / macOS
$ ./runtests.py\nWindows
...\\> runtests.py \nEsta es una nueva funcionalidad, por tlo anto debe ser documentada. Edite docs/topics/http/shortcuts.txt y agregue lo siguiente al final del archivo:
``make_toast()``\n================\n\n.. function:: make_toast()\n\n.. versionadded:: 2.2\n\nReturns ``'toast'``.\nDado que esta nueva característica estará en una próxima versión, también se añade a las notas de la próxima versión de Django. Abre las notas de la última versión en docs/releases/, que en el momento de escribir esto debería ser __django.version__. Añade una nota bajo el encabezado «Minor Features»:
:mod:`django.shortcuts`\n~~~~~~~~~~~~~~~~~~~~~~~\n\n* The new :func:`django.shortcuts.make_toast` function returns ``'toast'``.\nPara obtener más información sobre escribir la documentación, incluyendo una explicación de lo que se trata el fragmento versionadded, consulte Writing documentation. Esa página incluye también una explicación de cómo generar una copia de la documentación localmente, por lo que puede obtener una vista previa del código HTML que se generará.
Es el momento de revisar todos los cambios realizados en nuestro parche. Para poner en escena todos los cambios listos para su confirmación, ejecuta:
\nLinux / macOS
$ git add --all\nWindows
...\\> git add --all\nA continuación, muestra las diferencias entre tu copia Django actual y la revisión del checkout inicial del tutorial ejecutando:
\nLinux / macOS
$ git diff --cached\nWindows
...\\> git diff --cached\nUse las flechas del teclado para moverse arriba y abajo.
\ndiff --git a/django/shortcuts.py b/django/shortcuts.py\nindex 7ab1df0e9d..8dde9e28d9 100644\n--- a/django/shortcuts.py\n+++ b/django/shortcuts.py\n@@ -156,3 +156,7 @@ def resolve_url(to, *args, **kwargs):\n\n # Finally, fall back and assume it's a URL\n return to\n+\n+\n+def make_toast():\n+ return 'toast'\ndiff --git a/docs/releases/2.2.txt b/docs/releases/2.2.txt\nindex 7d85d30c4a..81518187b3 100644\n--- a/docs/releases/2.2.txt\n+++ b/docs/releases/2.2.txt\n@@ -40,6 +40,11 @@ database constraints. Constraints are added to models using the\n Minor features\n --------------\n\n+:mod:`django.shortcuts`\n+~~~~~~~~~~~~~~~~~~~~~~~\n+\n+* The new :func:`django.shortcuts.make_toast` function returns ``'toast'``.\n+\n :mod:`django.contrib.admin`\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\ndiff --git a/docs/topics/http/shortcuts.txt b/docs/topics/http/shortcuts.txt\nindex 7b3a3a2c00..711bf6bb6d 100644\n--- a/docs/topics/http/shortcuts.txt\n+++ b/docs/topics/http/shortcuts.txt\n@@ -271,3 +271,12 @@ This example is equivalent to::\n my_objects = list(MyModel.objects.filter(published=True))\n if not my_objects:\n raise Http404("No MyModel matches the given query.")\n+\n+``make_toast()``\n+================\n+\n+.. function:: make_toast()\n+\n+.. versionadded:: 2.2\n+\n+Returns ``'toast'``.\ndiff --git a/tests/shortcuts/test_make_toast.py b/tests/shortcuts/test_make_toast.py\nnew file mode 100644\nindex 0000000000..6f4c627b6e\n--- /dev/null\n+++ b/tests/shortcuts/test_make_toast.py\n@@ -0,0 +1,7 @@\n+from django.shortcuts import make_toast\n+from django.test import SimpleTestCase\n+\n+\n+class MakeToastTests(SimpleTestCase):\n+ def test_make_toast(self):\n+ self.assertEqual(make_toast(), 'toast')\nCuando hayas terminado de revisar el parche presiona q para volver a la línea de comandos. Si el contenido del parche se ve bien es tiempo de consumar los cambios.
Para confirmar los cambios:
\nLinux / macOS
$ git commit\nWindows
...\\> git commit\nEsto abre un editor de texto para escribir el mensaje de confirmación. Siga las guías para mensajes de confirmación y escriba un mensaje como:
\nFixed #99999 -- Added a shortcut function to make toast.\nAfter committing the patch, send it to your fork on GitHub (substitute\n«ticket_99999» with the name of your branch if it’s different):
\nLinux / macOS
$ git push origin ticket_99999\nWindows
...\\> git push origin ticket_99999\nPuede crear una solicitud de fusión visitando La página GitHub de Django. Verá su rama en «Your recently pushed branches». Haga clic en «Compare & pull request».
\nPor favor, no lo haga para este tutorial, pero en la siguiente página que se muestra una vista previa del parche, debería hacer clic en «Create pull request».
\n¡Enhorabuena, ha aprendido cómo hacer una solicitud de fusión a Django! Encontrará detalles de técnicas más avanzadas que puede necesitar en Working with Git and GitHub.
\nAhora puedes dar un buen uso a esas habilidades ayudando a mejorar la base de código de Django.
\nAntes de que se involucre mucho en la escritura de parches para Django, hay algo más de información sobre cómo contribuir a la que probablemente debería echarle un vistazo:
\nDebe asegurarse de leer la documentación de Django sobre reclamar tickets y enviar parches. Esta incluye la etiqueta de Trac, cómo reclamar tickets para uno mismo, el estilo esperado de codificación para parches y muchos otros detalles importantes.
Las personas que colaboran por primera vez también deben leer la documentación para los colaboradores principiantes de Django. Tiene muchos buenos consejos para aquellos de nosotros que somos nuevos en esto de colaborar con Django.
Después de ellos, si todavía quiere más información sobre cómo contribuir, siempre se puede navegar por el resto de la documentación de Django sobre cómo contribuir. Este contiene un montón de información útil y debe ser su primera fuente para responder a cualquier pregunta que pueda tener.
Una vez que haya revisado parte de esa información, estará listo para salir y encontrar un ticket al cual escribirle un parche. Preste especial atención a los tickets con el criterio de «easy pickings». Estos tickets son a menudo de carácter mucho más simples y son geniales para los que colaboran por primera vez. Una vez que esté familiarizado con como contribuir con Django, puede pasar a escribir parches para los tickets más difíciles y complicados.
\nIf you just want to get started already (and nobody would blame you!), try\ntaking a look at the list of easy tickets that need patches and the\neasy tickets that have patches which need improvement. If you’re familiar\nwith writing tests, you can also look at the list of\neasy tickets that need tests. Remember to follow the guidelines about\nclaiming tickets that were mentioned in the link to Django’s documentation on\nclaiming tickets and submitting patches.
\nDespués de que un ticket tiene un parche, necesita ser revisado por un segundo par de ojos. Después de enviar una solicitud de fusión asegúrese de actualizar los metadatos del ticket mediante el establecimiento de banderas en el ticket para decir «tiene parche», «no necesita pruebas», etc, para que otros puedan encontrarlo para su revisión. Contribuir no necesariamente siempre significa escribir un parche desde cero. Revisar parches existentes es también una contribución muy útil. Consulte: doc:/internals/contributing/triaging-tickets para más detalles.
\n