From d6efd4edb3743d6a74a68c133ec780a749ae63e7 Mon Sep 17 00:00:00 2001 From: taitus Date: Mon, 12 Aug 2024 19:17:17 +0200 Subject: [PATCH] Update communication instructions --- docs/en/getting_started/communication.md | 6 +++--- docs/es/getting_started/communication.md | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/getting_started/communication.md b/docs/en/getting_started/communication.md index 17229ab16..bf348d824 100644 --- a/docs/en/getting_started/communication.md +++ b/docs/en/getting_started/communication.md @@ -2,12 +2,12 @@ The preferred way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consuldemocracy/docs/issues/new). -For more informal communication, chat with us at [Consul Democracy's gitter](https://gitter.im/consul/consul). - -Before doing it, **please take some time to check the [existing issues](https://github.com/consuldemocracy/consuldemocracy/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference! +Before doing it, **please take some time to check the [existing issues](https://github.com/consuldemocracy/consuldemocracy/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page. A little more help can make a huge difference! In order to write a new issue, take into account these few tips to make it easy to read and comprehend: - Try to use a descriptive and to-the-point title. - It's a good idea to include some sections -in case they're needed- such as: steps to reproduce the bug, expected behaviour/response, actual response or screenshots. - Also it could be helpful to provide your operating system, browser version and installed plugins. + +On the other hand, if you need a space for more informal and open interaction, we have the [Discussions](https://github.com/consuldemocracy/consuldemocracy/discussions) section. It's similar to a discussion forum within the project, where you can ask questions, make suggestions, share ideas, and have conversations that don't necessarily fit into an issue or pull request. diff --git a/docs/es/getting_started/communication.md b/docs/es/getting_started/communication.md index 64745d498..67999164f 100644 --- a/docs/es/getting_started/communication.md +++ b/docs/es/getting_started/communication.md @@ -1,13 +1,13 @@ # Comunicación -Para comunicar sugerencias/incidencias te animamos a [abrir una incidencia en el repositorio de Documentación de Consul Democracy](https://github.com/consuldemocracy/consuldemocracy/issues/new). +Para comunicar sugerencias o incidencias te animamos a [abrir una incidencia en el repositorio de Documentación de Consul Democracy](https://github.com/consuldemocracy/consuldemocracy/issues/new). -Para comunicaciones más informales, chatea con nosotros en el [gitter de consul](https://gitter.im/consul/consul) +Antes de hacerlo, **por favor, tómate un tiempo para comprobar las [incidencias ya existentes](https://github.com/consuldemocracy/consuldemocracy/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página, ¡un poco de ayuda puede marcar una gran diferencia! -Antes de hacerlo, **por favor tómate un tiempo para comprobar los [issues ya existentes](https://github.com/consuldemocracy/consuldemocracy/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página ‑¡un poco de ayuda puede marcar una gran diferencia! - -Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo más fácil de leer y comprender: +Para escribir una nueva incidencia, ten en cuenta estas recomendaciones para hacerlo más fácil de leer y comprender: - Intenta usar un título descriptivo. - Es buena idea incluir algunas secciones -en caso de que sean necesarias- como los pasos para reproducir el error, el comportamiento o respuesta que cabría esperar, la respuesta que devuelve o capturas de pantalla. - También puede ser de ayuda incluir en la descripción tu sistema operativo, versión del navegador que usaste y posibles plugins instalados. + +Por otro lado si necesitas un espacio donde poder interactuar de manera más informal y abierta disponemos de la sección de [Debates](https://github.com/consuldemocracy/consuldemocracy/discussions). Es similar a un foro de discusión dentro del proyecto, donde se pueden plantear preguntas, sugerencias, ideas y tener conversaciones que no necesariamente encajan en una incidencia o _pull request_.