Acerca de los envíos de repositorio
Solo se pueden enviar repositorios públicos propiedad de cuentas personales a GitHub Community Exchange.
Hay tres tipos de envíos de repositorio:
- Learn (Aprender). Repositorio para compartir instrucciones paso a paso para compilar un proyecto.
- Collaborate (Colaborar). Repositorio que busca colaboradores para trabajar en un proyecto.
- Learn and Collaborate (Aprender y colaborar). Repositorio que es una combinación de
Learn
yCollaborate
.
Ten en cuenta cuál es la finalidad principal del repositorio al elegir el tipo de envío para el repositorio.
Para promover el proyecto y hacer que sea más reconocible para otros alumnos, debes asignar uno o varios temas y ofertas de GitHub Student Developer Pack al repositorio. Para más información, consulta Clasificar tu repositorio con temas.
Una vez que se haya enviado un repositorio a GitHub Community Exchange, se publicará inmediatamente con la finalidad, los temas y las ofertas que hayas elegido. La comunidad de GitHub Community Exchange modera todos los envíos al repositorio.
Requisitos para el envío
El repositorio debe cumplir un conjunto mínimo de requisitos para que se acepte un envío. Durante el proceso de envío, si no se han cumplido los criterios de envío para el repositorio seleccionado, recibirás una notificación de los elementos que faltan.
Para un envío con una finalidad de Learn
, el repositorio debe tener:
- Una descripción.
- Un archivo LEARN.md para proporcionar instrucciones paso a paso, con texto o elementos multimedia, sobre cómo se ha compilado el proyecto. Idealmente, el archivo de LEARN.md deconstruirá el proyecto en componentes pequeños y proporcionará detalles exhaustivos de cada paso para que otros alumnos puedan codificar su proyecto siguiendo las instrucciones.
- Un archivo README.md para proporcionar una descripción detallada del proyecto.
- Una licencia para que otros usuarios sepan lo que pueden y no pueden hacer con el código fuente.
Para un envío con una finalidad de Collaborate
, el repositorio debe tener:
- Una descripción.
- Un archivo README.md para proporcionar una descripción detallada del proyecto.
- Una licencia para que otros usuarios sepan lo que pueden y no pueden hacer con el código fuente.
- Una o varias incidencias en los que los colaboradores trabajarán.
- Un archivo CONTRIBUTING.md para comunicar cómo se puede contribuir al proyecto.
Un buen envío de repositorio para las finalidades de Learn
y Collaborate
es un repositorio que sigue los estándares de la comunidad. Para más información, consulta Acerca de los perfiles de comunidad para los repositorios públicos.
Envío del repositorio
- Desde el panel GitHub Education, navega a la página de inicio de GitHub Community Exchange.
- Sobre la lista de repositorios, a la derecha de los filtros desplegables y de búsqueda, haz clic en Add repository (Agregar repositorio).
- En la ventana emergente, usa el menú desplegable ¿Cuál es la finalidad del envío? y selecciona una o varias entradas que coincidan con el envío.
- Usa el menú desplegable Which repository would you like to use? (¿Qué repositorio quieres usar?) y selecciona el repositorio para el envío. Si no se cumplieron los criterios del envío, recibirás una notificación de los elementos que faltan y podrás hacer clic en Editar el repositorio si quieres ver el repositorio y hacer cambios que te permitan cumplir con los criterios.
- Usa el menú desplegable Which offers did you use for your project? (¿Qué ofertas has usado para el proyecto?) y selecciona una o varias entradas que coincidan con el envío.
- Haz clic en Submit the project (Enviar el proyecto).