¿Mejores / malas prácticas para compartir código? [cerrado]

9

Cuanto más exploro Github , más me gusta. Realmente disfruto cómo la codificación se está volviendo más social.

Tengo curiosidad por saber si hay alguna mala práctica que los programadores deben evitar al compartir su código entre sí. Y al nombrar malas prácticas, ¿cuáles son las mejores prácticas para compartir código ?

Por ejemplo:

¿Es una mala práctica para un único repositorio tener múltiples scripts / proyectos llamados 'MiscProjects' ? Donde este repositorio, como su nombre lo indica, es una colección de pequeños guiones y proyectos diversos. Esto puede parecerse a cómo un programador organiza proyectos en su almacenamiento local, pero ¿posiblemente no sea óptimo para compartir código?

Tal vez si se hace un buen README / documentación, ¿sería mejor? ¿O mientras esté bien documentado, todo vale?

esponja
fuente

Respuestas:

9

Si bien no hay "malas prácticas" escritas en piedra, al igual que con otros sistemas de control de versiones, existen convenciones .

Su repositorio de Git debe ser lo más pequeño posible. Si viene del módulo CVS / SVN, era común tener un repositorio único estructurado que pudiera componer múltiples repositorios para varios proyectos. La forma de Git es dividirlos y tener repositorios de Git separados para cada proyecto. Las razones son:

  • Git es más rápido para repositorios más pequeños.
  • Debido a su diseño, cada operación afecta a todo el repositorio . Es ineficiente realizar operaciones de Git sobre proyectos necesarios si solo está trabajando en uno de ellos.

La documentación, como siempre, es imprescindible. Si bien las personas son expertas en la lectura de códigos, nadie quiere interpretar el código más de lo necesario. Usar el archivo README de nivel superior para describir el proyecto y la estructura del repositorio de Git siempre será algo bueno para aquellos involucrados (o que buscan involucrarse) en el proyecto.

La mayoría del proyecto en GitHub se ajusta a las convenciones. Úselos como ejemplos de cómo estructurar sus proyectos futuros.

JK
fuente