Lista de verificación para lanzar una biblioteca de código abierto [cerrado]
-
08-07-2019 - |
Pregunta
He estado trabajando en una biblioteca de desarrollo web (para el marco CodeIgniter) que espero lanzar pronto.
Esta sería mi primera contribución, y nunca he lanzado una biblioteca de código abierto en el pasado.
Quería apelar a la experiencia de algunos de ustedes sobre los pasos a seguir antes de su lanzamiento. Sé que las pruebas y la documentación son clave ... ¿qué más?
Solución
- Licencias ...........
- Empaquetado (por ejemplo, tarball fuente, repositorio de Debian, etc.)
- Grupo de debate
- Rastreador de problemas
- Noticias (para lanzamientos, anuncios de proyectos, etc.)
- Hoja de ruta
- Lista de conocidos "errores"
- Lista de características
- Lista de no objetivos
- Sitio de demostración
- Ejemplo de uso
Por supuesto, puedes lanzar algo con mucho menos ... todo se reduce a cuánto '' atractivo '' desea que su proyecto se reúna en público.
Otros consejos
asegúrese de que su código esté claramente comentado, cualquier cosa que fue trivial para implementar intentos documentados.
Para agregar a la lista de jdupont,
Documentación: muchos proyectos de SO se vuelven populares simplemente porque tienen una mejor documentación (Si corresponde) Video corto de las funciones principales, o una serie de videos cortos que muestran diferentes funciones. Eso es con frecuencia lo primero que miro. Si no tiene tiempo para ello, al menos algunas capturas de pantalla para que las personas puedan tener una idea de cómo interactúan las cosas.