From 0528069bf371bb58da5e837ad127494369b28948 Mon Sep 17 00:00:00 2001 From: rasputin <115251263+ra5pvt1n@users.noreply.github.com> Date: Sun, 20 Oct 2024 15:37:10 +0200 Subject: [PATCH] Update README.md Add Project Structure and Guidelines --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 835fdfa..431ae9f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,26 @@ ## Cómo contribuir -### 1. Fork este repositorio +### Estructura del proyecto + +En el directorio raíz hay cuatro subdirectorios: +- `en`, `es`, y `eu` contienen las guías traducidas en formato Markdown. +- `images` contiene subdirectorios con el nombre de cada guía donde se almacenan sus imágenes. + +### Directrices + +1. Los nombres de los archivos deben ser coherentes. +2. Utiliza el formato Markdown para las guías (`.md`). Si no estás familiarizado con Markdown, consulta esta [cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). También puedes copiar el formato de una guía existente seleccionando la opción `Code` en la barra de herramientas del archivo y copiando y pegando. +3. Si puedes, sube imágenes `.webp` en lugar de `.png` o `.jpg`. + +### Realizar cambios + +#### 1. Fork este repositorio ![fork](https://raw.githubusercontent.com/bitcointxoko/guides/refs/heads/main/images/README/fork.png) Haz clic en el botón de bifurcación de la barra de herramientas superior. Se te guiará a través de la creación de una bifurcación de este repositorio. -### 2. Haz tus cambios +#### 2. Haz tus cambios ![add-file](https://raw.githubusercontent.com/bitcointxoko/guides/refs/heads/main/images/README/add-file.png) @@ -20,7 +34,7 @@ Para editar un archivo existente, navega a ese archivo y haz clic en el botón E Cuando hayas terminado con tus cambios, confírmalos. Escribe una breve descripción de lo que has cambiado. -### 3. Enviar una pull request +#### 3. Enviar una pull request Una vez que hayas confirmado los cambios, GitHub te pedirá que abras una pull request.