Add post How to Contribute? (#261)

* Add post How to Contribute? * Transalte post to spanish and other fixes * Update contributing post --------- Co-authored-by: Emruz Hossain <[email protected]>
hugo-toha · Jan 24, 2024 · 789e696 · 789e696
1 parent 3843ab6
commit 789e696
Show file tree

Hide file tree

Showing 8 changed files with 284 additions and 8 deletions.
diff --git a/assets/jsconfig.json b/assets/jsconfig.json
@@ -3,7 +3,7 @@
   "baseUrl": ".",
   "paths": {
    "*": [
-    "../../../../../../tmp/hugo_cache_runner/modules/filecache/modules/pkg/mod/github.com/hugo-toha/toha/[email protected]/assets/*"
+    "../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/hugo-toha/toha/[email protected]/assets/*"
    ]
   }
  }

diff --git a/content/posts/configuration/sections/experiences/index.es.md b/content/posts/configuration/sections/experiences/index.es.md
@@ -78,6 +78,6 @@ Cada entrada de la sección `experiences` debería tener la siguiente informaci
 
 <!-- {{< vs 2 >}}
 
-La siguiente imagen muestra como se distribuye el contenido de `experiences.yaml` de la sección de `Experiencia`.
+La siguiente imagen muestra cómo se distribuye el contenido de `experiences.yaml` de la sección de `Experiencia`.
 
 {{< img src="images/experiences.png" >}} -->
diff --git a/content/posts/contributing/hero.png b/content/posts/contributing/hero.png
diff --git a/content/posts/contributing/index.es.md b/content/posts/contributing/index.es.md
@@ -0,0 +1,139 @@
+---
+title: "Cómo contribuir?"
+date: 2024-01-19T02:30:00+06:00
+description: Una guía de cómo contribuir al tema de toha
+author:
+  name: BernatBC
+  image: images/author/bernatbc.png
+menu:
+  sidebar:
+    name: Contribuyendo
+    identifier: Contribuyendo
+    weight: 900
+---
+
+## Maneras de contribuir
+
+Puedes contribuir a este tema de varias maneras.
+
+### Código
+
+Los Pull Requests son bienvenidos y estaré encantado de revisarlos. Simplemente siga los siguientes principios:
+
+- Manténgalo simple.
+- Manténgalo consistente con el diseño.
+- Utilice la menor cantidad de dependencias posible.
+- Ten paciencia.
+
+### Testeando y reportando errores
+
+- Puedes reportar un [bug](https://github.com/hugo-toha/toha/issues/new?template=bug.md)
+- También puedes [pedir una característica](https://github.com/hugo-toha/toha/issues/new?template=feature_request.md)
+- [Dar ideas y sugerencias](https://github.com/hugo-toha/toha/issues/new?template=question.md)
+
+### Documentación
+
+También puedes contribuir con la documentación del tema:
+You can also contribute to the theme documentation by:
+- Añadiendo información y secciones.
+- Corrigiendo errores y faltas de ortografía.
+- Actualizando documentación obsoleta.
+- Traduciendo la documentación a un nuevo idioma, [esta](/es/posts/translation/content/) guía te podría ser útil.
+
+### Traducción
+
+Finalmente, puedes contribuir a la traducción del tema a distintos idiomas, completando palabras que faltan, o añadiendo un nuevo idioma. Puedes seguir la guía [Cómo añadir un idioma sin soporte](/es/posts/translation/new-language/) para más información.
+
+## Cómo contribuir?
+
+Para el desarrollo local, puedes hacer cambios al submódulo del tema y probar los cambios con tu propio sitio o con el [sitio de ejemplo](https://github.com/hugo-toha/hugo-toha.github.io) localmente.
+
+### Fork
+
+Para comenzar, haz fork de [este repositorio](https://github.com/hugo-toha/toha). Después, sigue los siguientes pasos para usar el tema forkeado para el desarrollo local,
+
+
+#### Ejecuta el tema forkeado con el sitio de ejemplo
+
+Si quieres ejecutar tu desarrollo local con este [sitio de ejemplo](https://github.com/hugo-toha/hugo-toha.github.io), sigue los siguientes pasos:
+
+```bash
+# va al directorio exampleSite
+$ cd exampleSite
+# instala los módulos de hugo
+$ hugo mod tidy
+# instala las dependencias
+$ hugo mod npm pack
+$ npm install
+# ejecuta el sitio de ejemplo localmente
+$ hugo server -w
+```
+
+Ahora, puedes hacer cambios en el tema, y se verán reflectados inmediatamente en el sitio. Si necesitas cambiar alguna configuración, lo puedes hacer en el archivo `config.yaml` dentro del directorio `exampleSite`. Si necesitas añadir contenido o datos, puedes crear el respectivo directorio dentro de `exampleSite` y añade tu contenido o datos deseados ahí.
+
+#### Ejecuta el tema forkeado con tu propio sitio
+
+Si quieres ejecutar tu desarrollo local con tu sitio, sigue los siguientes pasos:
+
+**Sustituye los módulos del tema:**
+
+Abre el archivo `go.mod` de tu sitio y sustituye `github.com/hugo-toha/toha/v4` por el path de tu repositorio forkeado. Por ejemplo, si tu repositorio forkeado es `github.com/<tu-usuario-de-github>/toha`, sustituye `github.com/hugo-toha/toha/v4` por `github.com/<tu-usuario-de-github>/toha/v4`.
+
+```go
+module github.com/hugo-toha/hugo-toha.github.io
+
+go 1.19
+
+require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect
+
+replace(
+    github.com/hugo-toha/toha/v4 => github.com/<your-github-user>/toha <git branch>
+)
+```
+
+Para el desarrollo interactivo, puedes sustituir el tema con tu fork clonado localmente. Por ejemplo, si has clonado tu fork en `/home/mis-proyectos/toha`, sustituye `github.com/hugo-toha/toha/v4` por `/home/mis-proyectos/toha`.
+
+```go
+module github.com/hugo-toha/hugo-toha.github.io
+
+go 1.19
+
+require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect
+
+replace(
+    github.com/hugo-toha/toha/v4 => /home/my-projects/toha
+)
+```
+
+**Actualizar dependencias:**
+
+```bash
+# actualiza los módulos de hugo
+$ hugo mod tidy
+# instala las dependencias
+$ hugo mod npm pack
+$ npm install
+```
+
+**Ejecuta tu sitio localmente:**
+
+```bash
+$ hugo server -w
+```
+
+Desde aquí ya puedes hacer cambios al código fuente del tema mientras lo pruebas con tu sitio Hugo o con el de ejemplo.
+
+### Abre un Pull Request
+
+Cuando ya hayas hecho los cambios, haz commit y haz push a tu fork.
+
+```bash
+# añade todos los cambios
+$ git add .
+# haz commit de los cambios con un mensaje significativo
+$ git commit -m "Un mensaje de commit significativo"
+# haz push del commit a tu fork
+$ git push my-fork mi-nueva-rama
+```
+
+Después, abre un Pull Request en la rama `main` de [hugo-toha/toha](https://github.com/hugo-toha/toha) desde la rama `mi-nueva-rama` de tu propio fork.
diff --git a/content/posts/contributing/index.md b/content/posts/contributing/index.md
@@ -0,0 +1,137 @@
+---
+title: "How to Contribute?"
+date: 2024-01-19T02:30:00+06:00
+description: A guide on how to contribute to toha
+author:
+  name: BernatBC
+  image: images/author/bernatbc.png
+menu:
+  sidebar:
+    name: Contributing
+    identifier: contributing
+    weight: 900
+---
+
+## Ways to Contribute
+
+You can contribute to this theme in various ways.
+
+### Code
+
+Pull requests are most welcome and I will be happy to review. Just follow the following principles:
+
+- Keep it simple.
+- Keep it consistent with the design.
+- Use as few dependencies as possible.
+- Have patience.
+
+### Testing and reporting issues
+
+- You can report a [bug](https://github.com/hugo-toha/toha/issues/new?template=bug.md)
+- File a [feature request](https://github.com/hugo-toha/toha/issues/new?template=feature_request.md)
+- [share your thoughts](https://github.com/hugo-toha/toha/issues/new?template=question.md)
+
+### Documentation
+
+You can also contribute to the theme documentation by:
+- Adding information and sections
+- Fixing errors and typos
+- Updating obsolete documentation
+- Translating the documentation to a new language, [this](/posts/translation/content/) guide might be helpful.
+
+### Translation
+
+Finally, you can contribute to the translation of the theme to several languages, by completing missing words, or by adding a new language. You can follow the guide [How to add an unsupported language](/posts/translation/new-language/) for more information.
+
+## How to contibute?
+
+For local development, you can make changes in the theme submodule and test the changes against your own site or this [example site](https://github.com/hugo-toha/hugo-toha.github.io) locally.
+
+### Fork
+
+At first, fork [this repo](https://github.com/hugo-toha/toha). Then, follow the following steps to use the forked theme for local developments,
+
+#### Running the forked theme against the example site
+
+If your want to run your local development against this [example site](https://github.com/hugo-toha/hugo-toha.github.io), follow the following steps:
+
+```bash
+# go to exampleSite directory
+$ cd exampleSite
+# install hugo modules
+$ hugo mod tidy
+# install dependencies
+$ hugo mod npm pack
+$ npm install
+# run the example site locally
+$ hugo server -w
+```
+
+Now, you can make change in the theme and they will be reflected immediately on the running site. If you need to change any configuration, you can do that in the `config.yaml` file inside `exampleSite` folder. If you need to add any content or data, you can create the respective folder inside `exampleSite` directory and add your desired content or data there.
+
+#### Running the forked theme against your own site
+
+If you want to run your local development against your own site, follow the following steps:
+
+**Replace the theme module:**
+
+Open your site's `go.mod` file and replace the `github.com/hugo-toha/toha/v4` with your forked repo's path. For example, if your forked repo is `github.com/<your-github-user>/toha`, then replace the `github.com/hugo-toha/toha/v4` with `github.com/<your-github-user>/toha/v4`.
+
+```go
+module github.com/hugo-toha/hugo-toha.github.io
+
+go 1.19
+
+require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect
+
+replace(
+    github.com/hugo-toha/toha/v4 => github.com/<your-github-user>/toha <git branch>
+)
+```
+
+For interactive development, you can replace the theme with your locally cloned fork. For example, if you have cloned your fork in `/home/my-projects/toha`, then replace the `github.com/hugo-toha/toha/v4` with `/home/my-projects/toha`.
+
+```go
+module github.com/hugo-toha/hugo-toha.github.io
+
+go 1.19
+
+require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect
+
+replace(
+    github.com/hugo-toha/toha/v4 => /home/my-projects/toha
+)
+```
+
+**Update dependencies:**
+
+```bash
+# update hugo modules
+$ hugo mod tidy
+# install dependencies
+$ hugo mod npm pack
+$ npm install
+```
+
+**Run your site locally:**
+
+```bash
+$ hugo server -w
+```
+
+From there you can make changes to the source code of the theme while testing with your running Hugo site or the example site.
+
+### Open a Pull Request
+
+When the changes look good, commit and push them to your fork.
+
+```bash
+# stage all the changes
+$ git add .
+# commit the changes with a meaning full commit message
+$ git commit -m "A meaningful commit message"
+# push the commit to your fork
+$ git push my-fork my-feature-branch
+```
+
+Then, open a PR against `main` branch of [hugo-toha/toha](https://github.com/hugo-toha/toha) from the `my-feature-branch` branch of your own fork.
diff --git a/content/posts/translation/content/index.es.md b/content/posts/translation/content/index.es.md
@@ -1,5 +1,5 @@
 ---
-title: "Como traducir las publicaciones"
+title: "Cómo traducir las publicaciones"
 date: 2020-06-07T06:20:50+06:00
 author:
   name: BernatBC
@@ -14,15 +14,15 @@ menu:
 
 Este tema tiene soporte integrado para varios idiomas.
 
-Antes de empezar la traducción de la publicación, asegúrese de haber habilitado el idioma en su sitio. Si ese no es el caso, puedes seguir la sección `Añade el idioma en el sitio` de la guía [Como traducir los datos de la página de inicio](/es/posts/translation/site-data/).
+Antes de empezar la traducción de la publicación, asegúrese de haber habilitado el idioma en su sitio. Si ese no es el caso, puedes seguir la sección `Añade el idioma en el sitio` de la guía [Cómo traducir los datos de la página de inicio](/es/posts/translation/site-data/).
 
 ## Creando la publicación
 
 Una vez que haya agregado el idioma deseado a su sitio web, sepa que puede traducir publicaciones a ese idioma. Asumiremos que deseas traducir una publicación existente.
 
 ### Creado el archivo index
 
-El primer paso es localizar el archivo `index.md` del post que deseas traducir. Después, crea un archivo en el mismo directorio (o simplemente copia el archivo `index.md`), y nómbralo `index.<código_del_idioma>.md`, dónde `<código_del_idioma>` es el código que encontrará en la tabla de idiomas de [Como traducir los datos de la página de inicio](/es/posts/translation/site-data/).
+El primer paso es localizar el archivo `index.md` del post que deseas traducir. Después, crea un archivo en el mismo directorio (o simplemente copia el archivo `index.md`), y nómbralo `index.<código_del_idioma>.md`, dónde `<código_del_idioma>` es el código que encontrará en la tabla de idiomas de [Cómo traducir los datos de la página de inicio](/es/posts/translation/site-data/).
 
 ### Traduce la publicación
 

diff --git a/content/posts/translation/site-data/index.es.md b/content/posts/translation/site-data/index.es.md
@@ -1,5 +1,5 @@
 ---
-title: "Como traducir los datos de la página de inicio"
+title: "Cómo traducir los datos de la página de inicio"
 date: 2020-06-07T06:20:50+06:00
 author:
   name: BernatBC
@@ -88,4 +88,4 @@ Luego, puede crear sus archivos de datos habituales, como `about.yaml` o `educat
 
 ## A continuación
 
-Puedes consultar la siguiente guía [Como traducir las publicaciones](/es/posts/translation/content/).
+Puedes consultar la siguiente guía [Cómo traducir las publicaciones](/es/posts/translation/content/).
diff --git a/content/posts/writing-posts/organizing/category/index.es.md b/content/posts/writing-posts/organizing/category/index.es.md
@@ -91,7 +91,7 @@ menu:
 ### Próximamente...
 ```
 
-Ya conocemos los parámetros usados aquí, pero tenemos uno nuevo incluido, que es `parent`. Si nos damos cuenta, entenderemos que el valor de este parámetro y el valor del parámetro `identifier` en el archivo `_index.md` dentro de este directorio son ambos iguales. Debemos tener cuidado de que el valor de ambos parámetros coincida. Ahora puedes agregar tantas publicaciones y categorías como quieras siguiendo el procedimiento mencionado anteriormente. Así es como creamos las categorías.
+Ya conocemos los parámetros usados aquí, pero tenemos uno nuevo incluido, que es `parent`. Si nos damos cuenta, entenderemos que el valor de este parámetro y el valor del parámetro `identifier` en el archivo `_index.md` dentro de este directorio son ambos iguales. Debemos tener cuidado de que el valor de ambos parámetros coincida. Ahora puedes agregar tantas publicaciones y categorías como quieras siguiendo el procedimiento mencionado anteriormente. Así es cómo creamos las categorías.
 
 La siguiente imagen muestra cómo el contenido está distribuido en la sección de la barra lateral.