Este material fue originalmente publicado en Habr.com en ruso. El autor permitió que se tradujera y publicara en Codingsight.
Tal vez, todos tengan en algún lugar un archivo para guardar ciertas cosas interesantes y útiles, como enlaces a artículos, libros, repositorios, manuales, etc. Puede usar marcadores en un navegador o pestañas, aún abiertas y esperando por usted. Con el tiempo, todo crece en exceso, los enlaces se rompen y los materiales se vuelven obsoletos.
Pero, ¿y si pudiéramos compartir estas gemas perspicaces con la comunidad? ¿Subir un archivo a GitHub? Entonces, sus hallazgos serían útiles para otra persona. Además, sería más fácil mantener el archivo actualizado juntos, actualizando la lista a través de las buenas y antiguas solicitudes de extracción.
Para eso tenemos el proyecto Awesome Lists.
Awesome Lists se encuentra entre los 10 principales repositorios de GitHub, y ya cuenta con 138 000 "estrellas", y un enlace a sus trabajos puede llegar a su README raíz, lo que atrae a una gran audiencia. Sin embargo, primero tendrás que hacer un esfuerzo. Aquí, quiero compartir mi experiencia.
Soy Maksim Gramin, desarrollador de Java e investigador de bases de datos en CROC, una empresa internacional de TI con sede en Moscú. Este artículo le informará sobre Awesome Lists y cómo hacer su impresionante repositorio oficial.
¿De qué se tratan las listas increíbles?
Siempre que tengo que lidiar con alguna nueva tecnología o un lenguaje de programación, primero voy allí, buscando la sección necesaria y las listas apropiadas. Dada la gran y cada vez mayor cantidad de "estrellas", no soy la única persona con ese enfoque.
De hecho, "Awesome Lists" es un archivo Léame.md simple estándar que vive en un repositorio separado. Sin embargo, ocupa la posición 8 entre todos los repositorios de GitHub e incluye otras listas dedicadas a determinados temas. Por ejemplo, la sección Lenguajes de programación tiene listas Awesome Python y Awesome Go, mientras que la sección Desarrollo front-end almacena numerosos materiales de desarrollo web. Por último, pero no menos importante, está la sección Base de datos (hablaremos de ella un poco más adelante).
Por supuesto, el contenido no se limita solo a temas técnicos y también incluye otras secciones, como Entretenimiento y Juegos. También puedes encontrar muchas cosas emocionantes allí (estoy muy feliz con la lista de fantasía asombrosa).
La principal distinción del proyecto es que todas estas listas son administradas no solo por el autor, sino por la comunidad. Además, todos están hechos de acuerdo con un estricto Manifiesto Awesome. Cada lista representa una comunidad separada de especialistas, que vive su propia vida y está abierta a sus solicitudes de extracción, lo que la hará aún mejor. Además, cualquiera puede crear su propia lista en caso de que falte explorar algún tema.
Por la idea original y la coordinación de todo este material, debemos agradecer al legendario Sindre Sorhus, el primer hombre en GitHub y autor de más de 1000 módulos npm. Él es quien aceptará tus solicitudes de extracción.
Cómo hacer una lista impresionante
Si no ha encontrado la lista correcta para el tema necesario, ¡es la primera señal de que debe hacerlo usted mismo! Te diré cómo hacerlo con el ejemplo de mi propia creación:Awesome Database Tools.
Proyecto por proyecto, tuve que lidiar con todo tipo de bases de datos. Así, comencé a administrar algunos archivos donde reuní diferentes herramientas útiles para el trabajo. Hubo varios migradores de base de datos, IDE, paneles de administración, herramientas de monitoreo, etc., incluidos los que ya usé o solo planeé usar.
Compartí este archivo con mis colegas en CROC y más allá, alentado por ver cómo benefició a muchos de ellos. Entonces, quería más. Cuando noté que la sección Bases de datos carecía de una lista dedicada a las herramientas, decidí agregar la mía.
¿Qué necesitas para eso?
- Registre un repositorio estándar de GitHub y asígnele el nombre Awesome-smth; en mi caso, fue Awesome-Database-Tools.
- Ajuste la lista a lo impresionante formato usando generador-awesome-list que generará todos los archivos necesarios en el formato correcto.
- Configurar la integración continua (CI):awesome-lint y Travis CI nos ayudarán a controlar la validez de la lista.
- Espere 30 días.
- Revise al menos otras 2 solicitudes de incorporación de cambios.
- Realice una solicitud de incorporación de cambios al repositorio principal y agregue un enlace a nuestro propio repositorio. Importante :Lea detenidamente todos los numerosos requisitos de la nueva lista y las solicitudes de incorporación de cambios, y sígalos con precisión.
Mi primer intento no tuvo éxito.
Sin embargo, después de un tiempo, recopilé más materiales, hice mi tarea, arreglé los errores e intenté por segunda vez.
Pero olvidé una cosa crucial, y me lo recordaron cortésmente:
No estuve lo suficientemente atento y no agregué un unicornio como confirmación del cumplimiento de todas las condiciones.
Pasó un poco más de tiempo, recibí más comentarios y agregué enmiendas y, finalmente, vi un tuit largamente esperado de que mi PR había sido aceptado.
Así es como hice mi primera lista y comencé a recibir solicitudes de extracción de la comunidad para agregar nuevas herramientas. Muchos de ellos ya están incluidos en Awesome Database Tools.
Si tiene buenas ideas para las bases de datos, no dude en compartirlas. Además, estaré encantado de recibir sus comentarios, como solicitudes de incorporación de cambios y estrellas. Si tiene alguna pregunta sobre cómo hacer sus propias listas, hágamelo saber.
Puede ponerse en contacto con el autor en [email protected].
