Colaborar

Se colabora con el procedimiento de siempre: abrir un issue si el cambio es grande, hacer fork y una rama, pasar las comprobaciones y abrir un pull request. Esta parte explica cómo está construido el proyecto, para que puedas entenderlo, arreglar algo o añadir algo.

Está pensada para quien programa y no conoce el proyecto. Se usan términos técnicos (operación, reloj lógico híbrido, conformidad), pero cada uno se explica la primera vez que sale, y siempre se dice por qué se hizo así.

Para empezar

1. Las piezas y cómo encajan: la app, el dominio, la especificación, el servidor y qué pasa al añadir un libro.
2. Preparar el entorno: la app: Rust, Node, Android y las comprobaciones.
3. Preparar el entorno: el servidor: Docker, las bases de datos, las fixtures y make check.
4. Cómo contribuir: estilo, pruebas y commits: las reglas que importan y cómo añadir un campo o una entidad.
5. Glosario: cómo se llama cada cosa en español y en el código.

Cómo funciona por dentro

6. El motor de sincronización, explicado: cómo varios dispositivos llegan al mismo resultado sin que nadie mande.
7. Las operaciones: la especificación y los casos de conformidad: el formato, las reglas y cómo escribir un cliente o un servidor compatible.
8. Seguridad: el modelo de amenazas: de quién protege, con qué piezas y qué no protege.
9. Cómo auditamos, para repetirlo por tu cuenta: el método, no los informes.
10. Avisar de un fallo de seguridad: cómo hacerlo en privado.

Los datos, las cuentas y la nube

11. El modelo de datos: las entidades del catálogo y de compartir, y por qué la obra y la edición van separadas.
12. Cuentas e inicio de sesión: registro, Google, segundo factor y el dispositivo como sesión.
13. La nube: la API y las reglas de acceso: un mapa de las rutas y de quién llega a qué biblioteca.

Publicar

14. Publicar una versión: el número, las novedades, las licencias y el paquete firmado de Android.
15. Añadir una fuente de datos: un catálogo nuevo en la app, y en el servidor si hace falta.
16. Añadir un idioma: los textos de la app, las novedades, los correos del servidor y la documentación.

Documentos del repositorio

• CONTRIBUTING.md, el procedimiento y las reglas que importan (en inglés).
• SECURITY.md, cómo avisar de un fallo de seguridad en privado.
• CODE_OF_CONDUCT.md.
• El registro de decisiones y la arquitectura, en español.
• El nombre y los logos: qué se puede hacer con ellos, y los logos para descargar.