Introducción
Antes de sumergirte en el desarrollo, esperamos que comprendas lo siguiente:- Overleaf se desarrolla oficialmente en un repositorio interno, y la edición comunitaria se publica en overleaf/overleaf. Un copybot se encarga de sincronizar el código entre el repositorio interno y el público.
- Ayaka-notes/overleaf-pro es una versión bifurcada (fork) de Overleaf Community. Queremos que este proyecto sea sostenible a largo plazo, así que sigue estas reglas antes de contribuir.
Reglas de commits
- No realices modificaciones extensas en el código existente de Overleaf. Concentra tanta funcionalidad como sea posible en la carpeta
services/web/modules. Así minimizaremos el trabajo al fusionar y actualizar el código más adelante. - El vibe coding es realmente una forma muy sencilla de trabajar, pero puede desordenar fácilmente nuestro proyecto y hacerlo inmantenible más adelante, así que úsalo con precaución.
- No añadas contenido relacionado con traducciones durante el desarrollo; utiliza las traducciones existentes siempre que sea posible.
- Evita introducir variables de entorno salvo que sea absolutamente necesario. Si son necesarias, asegúrate de que sean lo más coherentes posible con las del Overleaf Toolkit o de docs.overleaf.com.
Reglas de ramas
Usamos las siguientes ramas para el desarrollo de overleaf-pro:main: esta rama se usa solo para sincronizar el código upstream; NO hagas commit de ningún cambio externo. En esta rama crearemos etiquetas comoce-v[X.x.x], que indican que corresponde av[X.x.x]de la Community Edition oficial de Overleaf. Nota: ¡esta etiqueta es inmutable!server-pro: esta es la rama predeterminada para el desarrollo diario.feature-X: esta rama se usa para desarrollar una funcionalidad específica.release-vX.0.0: rama específica para una versión; en ella aplicaremos algunas correcciones urgentes (hot-fix) antes del lanzamiento.
Reglas de ramas para Overleaf Pro
GitHub Action
GitHub Action se encarga del CI/CD automático, que incluye:- Actualización nocturna de la rama main
- Compilación de la imagen de Docker para desarrollo
- Publicación de la imagen de Docker
Preguntas y respuestas
¿Cómo encontrar el hash del commit de Overleaf Community Edition X.0.0?
¿Cómo encontrar el hash del commit de Overleaf Community Edition X.0.0?
En primer lugar, descarga la imagen de Docker y ejecuta el siguiente comando para inspeccionar las etiquetas de esa imagen:Después puedes comprobar si el commit (b0d05c0) está presente en la rama master upstream.
bash
¿Por qué el hash del commit es el mismo en la imagen CE entre 6.0.0 y 6.0.1?
¿Por qué el hash del commit es el mismo en la imagen CE entre 6.0.0 y 6.0.1?
Este es el comportamiento esperado. La versión 6.0.1 es un parche menor construido sobre la imagen 6.0.0. Los cambios se aplican parcheando la imagen 6.0.0 existente, en lugar de reconstruir la imagen a partir de un nuevo commit. Por lo tanto, el hash del commit dentro de la imagen es idéntico entre 6.0.0 y 6.0.1.Para más información, consulta hotfix.