diff --git a/es/CHANGELOG.md b/es/CHANGELOG.md index e69de29..9baa0f4 100644 --- a/es/CHANGELOG.md +++ b/es/CHANGELOG.md @@ -0,0 +1,52 @@ +# Registro de cambios + +Todos los cambios notables de este proyecto se documentarán en este archivo. + +El formato se basa en [Keep a Changelog](http://keepachangelog.com/) +y este proyecto se adhiere a [Semantic Versioning](http://semver.org/). + +## [Inédito]: aaaa-mm-dd + +Aquí escribimos notas de actualización para las marcas. Es un esfuerzo de equipo hacerlos como +lo más sencillo posible. + +### Agregado + +- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) + MENOR El título de la entrada va aquí. +- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) + PATCH El título del ticket va aquí. + +### Cambió + +### Reparado + +## [1.2.4] - 2017-03-15 + +Aquí tendríamos los pasos de actualización para 1.2.4 para que la gente los siga. + +### Agregado + +### Cambió + +- [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) + PATCH Drupal.org ahora se usa como compositor. + +### Reparado + +- [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) + PARCHE Agregue lógica al avance de la hoja de ejecución eliminar para eliminar el correspondiente + tarjetas de horario. + +## [1.2.3] - 2017-03-14 + +### Agregado + +### Cambió + +### Reparado + +- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) + Pruebas de foo del módulo de reparación MENOR +- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) + La línea de tiempo del módulo PRINCIPAL de foo usa la zona horaria del navegador para la resolución de la fecha \ No newline at end of file diff --git a/es/CODEBASE_STRUCTURE.md b/es/CODEBASE_STRUCTURE.md index e69de29..eefb257 100644 --- a/es/CODEBASE_STRUCTURE.md +++ b/es/CODEBASE_STRUCTURE.md @@ -0,0 +1,43 @@ +Estos son los directorios que estamos utilizando activamente en el desarrollo: + ++ [frontend / server / controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): +Los controladores hacen la lógica empresarial y exponen la API del servidor. ++ [frontend / server / libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Bibliotecas y utilidades. ++ [frontend / server / libs / dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Objetos de Acceso de Datos [DAO] y Objetos de valor [VO]. Clases utilizadas para representar esquemas de bases de datos y facilitar su uso por parte de los controladores. ++ [frontend / templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): plantillas de Smarty utilizado para generar el HTML que se muestra a los usuarios. ++ [frontend / www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): el contenido completo de la +página de Internet. + +### frontend / www + +Contenido: + ++ js / ++ css / + +#### js + +Como su nombre lo indica, aquí es donde residen todas las fuentes y marcos de JavaScript. Cuando desee realizar cambios, minimice el javascript y luego cárguelo. + +#### css + +Similar a js, aquí están los archivos css minificados. + +### frontend / servidor + +Contenido: + ++ dao / ++ controladores / + +Ninguno de estos módulos debería ser accesible para el mundo exterior. El único que puede llamarlos es la interfaz de usuario. Por eso están en la carpeta www. + +#### DAO / VO + +La carpeta *dao* contiene las clases para la capa de acceso a datos. Tiene 2 cosas que saber: *objetos de acceso a datos* y *objetos de valor*. Los *objetos de valor* (VO) no son más que clases que se asignan directamente a cada una de las tablas de la base de datos. Por lo tanto, hay una clase allí llamada Usuarios, ya que hay una tabla con el mismo nombre. Esta clase tiene sus establecedores y captadores para cada uno de los campos de la base de datos. Los *objetos de acceso a datos* (dao) son clases estáticas para cada una de las tablas, y sirven para obtener y hacer persistentes los objetos *vo*. + +[Aquí hay más información sobre este modelo](http://www.ibm.com/developerworks/java/library/j-dao/) + +#### Controladores + +Los controladores son donde se toman las decisiones. El controlador usa los dao's y vo's para tomar decisiones y nunca llama directamente a la base de datos. De esta forma, evitamos tener controladores separados para cada módulo del proyecto. diff --git a/es/CODE_OF_CONDUCT.md b/es/CODE_OF_CONDUCT.md index e69de29..69ee532 100644 --- a/es/CODE_OF_CONDUCT.md +++ b/es/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Código de conducta del colaborador + +## Nuestro compromiso + +Con el fin de fomentar un entorno abierto y acogedor, como +contribuyentes y mantenedores se comprometen a participar en nuestro proyecto y +nuestra comunidad una experiencia libre de acoso para todos, independientemente de su edad, cuerpo +tamaño, discapacidad, etnia, características sexuales, identidad y expresión de género, +nivel de experiencia, educación, situación socioeconómica, nacionalidad, personal +apariencia, raza, religión o identidad y orientación sexual. + +## Nuestros estándares + +Ejemplos de comportamiento que contribuye a crear un entorno positivo. +incluir: + +* Usar un lenguaje acogedor e inclusivo +* Respetar los diferentes puntos de vista y experiencias. +* Aceptando con gracia las críticas constructivas +* Centrarse en lo que es mejor para la comunidad +* Mostrar empatía hacia otros miembros de la comunidad + +Ejemplos de comportamiento inaceptable por parte de los participantes incluyen: + +* El uso de lenguaje o imágenes sexualizadas y atención o atención sexual no deseada. + avances +* Trolling, comentarios insultantes / despectivos y ataques personales o políticos +* Acoso público o privado +* Publicar información privada de otros, como una información física o electrónica. + dirección, sin permiso explícito +* Otra conducta que razonablemente podría considerarse inapropiada en un + entorno profesional + +## Nuestras responsabilidades + +Los encargados del mantenimiento del proyecto son responsables de aclarar los estándares de +comportamiento y se espera que tomen las acciones correctivas apropiadas y justas en +respuesta a cualquier caso de comportamiento inaceptable. + +Los encargados del mantenimiento del proyecto tienen el derecho y la responsabilidad de eliminar, editar o +rechazar comentarios, confirmaciones, código, ediciones de wiki, problemas y otras contribuciones +que no están alineados con este Código de Conducta, o para prohibir temporalmente o +de forma permanente cualquier colaborador por otros comportamientos que consideren inapropiados, +amenazante, ofensivo o dañino. + +## Alcance + +Este Código de Conducta se aplica tanto dentro de los espacios del proyecto como en los espacios públicos. +cuando un individuo representa el proyecto o su comunidad. Ejemplos de +representar un proyecto o comunidad incluye el uso de un correo electrónico oficial del proyecto +dirección, publicando a través de una cuenta oficial de redes sociales, o actuando como un designado +representante en un evento en línea o fuera de línea. La representación de un proyecto puede ser +más definido y aclarado por los encargados del mantenimiento del proyecto. + +## Ejecución + +Los casos de comportamiento abusivo, acosador o inaceptable pueden ser +informado poniéndose en contacto con el equipo del proyecto en kylelobo20@gmail.com. Todos +Las quejas serán revisadas e investigadas y resultarán en una respuesta que +se considera necesario y apropiado a las circunstancias. El equipo del proyecto es +obligado a mantener la confidencialidad con respecto al informante de un incidente. +Se pueden publicar más detalles de las políticas de aplicación específicas por separado. + +Los mantenedores de proyectos que no siguen o hacen cumplir el Código de Conducta de manera adecuada +La fe puede enfrentar repercusiones temporales o permanentes según lo determinen otros +miembros de la dirección del proyecto. + +## Atribución + +Este Código de conducta está adaptado del [Pacto del colaborador] [página de inicio], versión 1.4, +disponible en https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[página de inicio]: https://www.contributor-covenant.org + +Para obtener respuestas a preguntas comunes sobre este código de conducta, consulte +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/es/CODING_GUIDELINES.md b/es/CODING_GUIDELINES.md index e69de29..14aec2f 100644 --- a/es/CODING_GUIDELINES.md +++ b/es/CODING_GUIDELINES.md @@ -0,0 +1,24 @@ +# Guiá de codificación + +- Puede validar que su código cumpla con estas reglas ejecutando `stuff / php-format.py validate` +- Tabuladores, sin espacios +- El final de la línea debe ser estilo Unix (`\n`), no estilo Windows (`\r\n`) +- Los corchetes de apertura van en la misma línea que la última declaración + +``` + if (condición) { + cosas; + } +``` + +- Un espacio entre palabras clave y paréntesis para: `if`,` else`, `while`,` switch`, `catch`,` function` +- Las llamadas a funciones no tienen espacio antes del paréntesis. +- No se dejan espacios entre paréntesis +- Un espacio después de cada coma, pero sin espacio antes +- Todos los operadores binarios deben tener un espacio antes y otro después +- No debe haber más de una línea en blanco contigua +- No debe haber comentarios vacíos. +- No debe usar comentarios de bloque `/ * ... * /`, solo línea `// ...` +- Los cambios en la funcionalidad deben ir acompañados de sus respectivas nuevas/modificadas pruebas +- Se deben utilizar excepciones para informar estados erróneos. Se permite el uso de funciones que devuelven verdadero/falso cuando son valores esperados +- Utilizar [RAII](https://es.wikipedia.org/wiki/RAII) cuando corresponda, principalmente en la administración de recursos (archivos, etc ...) diff --git a/es/CONTRIBUTING.md b/es/CONTRIBUTING.md index e69de29..6e5ef28 100644 --- a/es/CONTRIBUTING.md +++ b/es/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Guía de contribución + +- Contribuir al Compendio de documentación es bastante fácil. Este documento le muestra cómo empezar + +## General + +- La [Estructura de la base de código] (./ CODEBASE_STRUCTURE.md) tiene información detallada sobre cómo se estructuran los distintos archivos de este proyecto. +- Asegúrese de que los cambios que realice se ajusten a las [guiás de codificación] (./ CODING_GUIDELINES.md) de este repositorio. + +## Envío de cambios + +- Bifurcar el repositorio + - +- Crea una nueva rama basada en el nombre de lo que pretendes hacer: + - Ejemplo: + + ````console + $ git checkout -b NOMBRE_RAMA + ```` + + Si recibe un error, es posible que primero deba buscar fooBar usando + + ````console + $ git actualización remota && git fetch + ```` + + - Use una rama por reparación/característica + +- Confirma tus cambios + - Proporcione un mensaje de git que explique lo que ha hecho. + - Asegúrate de que tus confirmaciones sigan las [convenciones](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md) + - Envia commit con el repositorio bifurcado + - Ejemplo: + + ````console + $ git commit -am 'Agregar algo de fooBar' + ```` + +- Empujar a la rama + - Ejemplo: + + ````console + $ git push origin BRANCH_NAME + ```` + +- Hacer un Pull Request + - Asegúrese de enviar el PR a la rama fooBar + - ¡Travis CI te está mirando! + +Si sigue estas instrucciones, su PR aterrizará de forma bastante segura en el repositorio principal. \ No newline at end of file diff --git a/es/ISSUE_TEMPLATES/bug_report.md b/es/ISSUE_TEMPLATES/bug_report.md index e69de29..c6942e6 100644 --- a/es/ISSUE_TEMPLATES/bug_report.md +++ b/es/ISSUE_TEMPLATES/bug_report.md @@ -0,0 +1,41 @@ +--- +Nombre: Reporte de error +Acerca de: Crea un reporte para ayudarnos a mejorar. +Titulo: '' +Etiqueta: '' +Encargados: '' + +--- + +**Describe el error** +Una descripción clara y concisa de cuál es el error. + +**Reproducir** +Pasos para reproducir el comportamiento: + +1. Vaya a '...' +2. Haga clic en '....' +3. Desplácese hacia abajo hasta '....' +4. Ver error + +**Comportamiento esperado** +Una descripción clara y concisa de lo que esperaba que sucediera. + +**Capturas de pantalla** +Si corresponde, agregue capturas de pantalla para ayudar a explicar su problema. + +**Escritorio (complete la siguiente información):** + +- SO: [p. Ej. iOS] +- Navegador [p. Ej. cromo, safari] +- Versión [p. Ej. 22] + +**Smartphone (complete la siguiente información):** + +- Dispositivo: [p. Ej. iphone 6] +- SO: [p. Ej. iOS8.1] +- Navegador [p. Ej. navegador de valores, safari] +- Versión [p. Ej. 22] + +**Contexto adicional** +Agregue aquí cualquier otro contexto sobre el problema. diff --git a/es/ISSUE_TEMPLATES/custom.md b/es/ISSUE_TEMPLATES/custom.md index e69de29..88e620d 100644 --- a/es/ISSUE_TEMPLATES/custom.md +++ b/es/ISSUE_TEMPLATES/custom.md @@ -0,0 +1,8 @@ +--- +Nombre: Solicitud de función personalizada +Acerca de: Describe la función de la solicitud aqui. +Titulo: '' +Etiqueta: '' +Encargados: '' + +--- \ No newline at end of file diff --git a/es/ISSUE_TEMPLATES/feature_request.md b/es/ISSUE_TEMPLATES/feature_request.md index e69de29..c059bb8 100644 --- a/es/ISSUE_TEMPLATES/feature_request.md +++ b/es/ISSUE_TEMPLATES/feature_request.md @@ -0,0 +1,20 @@ +--- +Nombre: Solicitud de función +Acerca de: Sugiere una idea para este proyecto. +Titulo: '' +Etiqueta: '' +Encargados: '' + +--- + +**¿Su solicitud de función está relacionada con un problema? Por favor describa.** +Una descripción clara y concisa de cuál es el problema. Ex. Siempre me frustra cuando [...] + +**Describe la solución que te gustaría** +Una descripción clara y concisa de lo que quieres que suceda. + +**Describe las alternativas que has considerado** +Una descripción clara y concisa de cualquier solución o característica alternativa que haya considerado. + +**Contexto adicional** +Agregue cualquier otro contexto o capturas de pantalla sobre la solicitud de función aquí. diff --git a/es/PULL_REQUEST_TEMPLATE.md b/es/PULL_REQUEST_TEMPLATE.md index e69de29..424b7b4 100644 --- a/es/PULL_REQUEST_TEMPLATE.md +++ b/es/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +### Tu lista de verificación para este Pull Request + +🚨 Revise las [reglas para contribuir](./CONTRIBUTING.md) a este repositorio. + +- [] Asegúrese de que está solicitando **extraer una rama de tema / característica / corrección de errores** (lado derecho). ¡No solicites a tu rama principal! +- [] Asegúrate de realizar una solicitud de extracción contra la **rama fooBar** (lado izquierdo). +- [] Verifique que los estilos de mensaje de los commits o incluso de todos los commits coincidan con nuestra estructura solicitada. +- [] Compruebe que las adiciones de su código no fallarán ni en las comprobaciones de lint del código ni en la pruebas unitarias. + +### Descripción + +Describe tu solicitud de pull request. + +❤️ ¡Gracias! diff --git a/es/README_TEMPLATES/Bot.md b/es/README_TEMPLATES/Bot.md index e69de29..17f3258 100644 --- a/es/README_TEMPLATES/Bot.md +++ b/es/README_TEMPLATES/Bot.md @@ -0,0 +1,144 @@ +

+ + Bot logo +

+ +

Nombre del Bot

+ +
+ + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot) + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

🤖 Unas cuantas lineas describiendo que hace el bot. +
+

+ +## 📝 Tabla de contenido +- [📝 Tabla de contenido](#-tabla-de-contenido) +- [🧐 Acerca de ](#-acerca-de--) +- [🎥 Demostración ](#-demostración--) +- [💭 Cómo funciona ](#-cómo-funciona--) +- [🎈 Uso ](#-uso--) + - [Ejemplo](#ejemplo) +- [🏁 Comenzando ](#-comenzando--) + - [Requisitos previos](#requisitos-previos) + - [Instalación](#instalación) +- [🚀 Implementación de su propio bot ](#-implementación-de-su-propio-bot--) +- [⛏️ Creado con ](#️-creado-con--) +- [✍️ Autores ](#️-autores--) +- [🎉 Agradecimientos ](#-agradecimientos--) + +## 🧐 Acerca de + +Escribe entre 1 y 2 párrafos que describan el propósito de tu bot. + +## 🎥 Demostración + +![En funcionamiento](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif) + +## 💭 Cómo funciona + +El bot primero extrae la palabra del comentario y luego busca definiciones de palabras, parte del discurso, ejemplo y fuente de la API del Diccionario Oxford. + +Si la palabra no existe en el Diccionario Oxford, la API de Oxford devuelve una respuesta 404 en la que el bot intenta obtener resultados de la API del Diccionario Urbano. + +El bot usa la API Pushshift para buscar comentarios, el módulo PRAW para responder a los comentarios y Heroku como servidor. + +Todo el bot está escrito en Python 3.6 + +## 🎈 Uso + +Para usar el bot, escriba: + +``` +! dict palabra +``` + +La primera parte, es decir, "! Dict" ** no distingue entre mayúsculas y minúsculas. + +El bot le dará la definición de la palabra en el Diccionario Oxford (o Urban Dictionary, si la palabra no existe en el Diccionario Oxford) como respuesta a un comentario. + +### Ejemplo + +>! dict que es el amor + +**Definición:** + +Bebé, no me lastimes ~ +No me hagas daño ~ no más. + +**Ejemplo:** + +Amigo1: Bruh, ¿qué es el amor? +Dude2: Cariño, no me hagas daño, no me hagas daño, ¡no más! +Amigo1: ¿dafuq? + +**Fuente:** + +--- + + Bip boop. Soy un bot. Si hay algún problema, comuníquese con mi [Maestro](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot) + + ¿Quieres hacer un bot de reddit similar? Echa un vistazo a: [GitHub](https://github.com/kylelobo/Reddit-Bot) + +## 🏁 Comenzando + +Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo. + +### Requisitos previos + +Qué necesita para instalar el software y cómo instalarlo. + +``` +Dar ejemplos +``` + +### Instalación + +Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo. + +Di cuál será el paso + +``` +Da el ejemplo +``` + +Y repetir + +``` +hasta que termine +``` + +Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración. + +## 🚀 Implementación de su propio bot + +Para ver un proyecto de ejemplo sobre cómo implementar su bot, consulte mi propia configuración: + ++ **Heroku**: + +## ⛏️ Creado con + ++ [PRAW](https://praw.readthedocs.io/en/latest/) - Envoltorio de API de Python Reddit ++ [Heroku](https://www.heroku.com/) - Plataforma de alojamiento SaaS + +## ✍️ Autores + +- [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial +- [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español + +Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto. + +## 🎉 Agradecimientos + +- Apreciación para cualquier persona cuyo código se haya utilizado +- inspiración +- referencias diff --git a/es/README_TEMPLATES/Hackathon.md b/es/README_TEMPLATES/Hackathon.md index e69de29..32dcd19 100644 --- a/es/README_TEMPLATES/Hackathon.md +++ b/es/README_TEMPLATES/Hackathon.md @@ -0,0 +1,122 @@ +

+ + Project logo +

+

Titulo del proyecto

+ +
+ + [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) + +
+ +--- +

Pocas líneas que describen su proyecto. +
+

+ +## 📝 Tabla de contenido + +- [📝 Tabla de contenido](#-tabla-de-contenido) +- [🧐 Declaración del problema ](#-declaración-del-problema--) +- [💡 Idea / Solución ](#-idea--solución--) +- [⛓️ Dependencias / Limitaciones ](#️-dependencias--limitaciones--) +- [🚀 Alcance futuro ](#-alcance-futuro--) +- [🏁 Comenzando ](#-comenzando--) + - [Requisitos previos](#requisitos-previos) + - [Instalación](#instalación) +- [🎈 Uso ](#-uso--) +- [⛏️ Creado con ](#️-creado-con--) +- [✍️ Autores ](#️-autores--) +- [🎉 Agradecimientos ](#-agradecimientos--) + +## 🧐 Declaración del problema + +Es útil diseñar y seguir un formato específico al escribir una declaración de problema. Si bien hay varias opciones +Para hacer esto, la siguiente es una plantilla simple y directa que se usa a menudo en Business Analysis para mantener +céntrese en definir el problema. + +- IDEAL: Esta sección se utiliza para describir el estado deseado o "a ser" del proceso o producto. En general, esta sección +debe ilustrar cómo se vería el entorno esperado una vez implementada la solución. +- REALIDAD: Esta sección se utiliza para describir el estado actual o "tal cual" del proceso o producto. +- CONSECUENCIAS: Esta sección se utiliza para describir los impactos en el negocio si el problema no se soluciona o mejora. +Esto incluye los costos asociados con la pérdida de dinero, tiempo, productividad, ventaja competitiva, etc. + +Seguir este formato dará como resultado un documento viable que se puede utilizar para comprender el problema y obtener +requisitos que conducirán a una solución ganadora. + +## 💡 Idea / Solución + +Esta sección se utiliza para describir posibles soluciones. + +Una vez que las secciones de ideal, realidad y consecuencias han sido +completado y comprendido, resulta más fácil proporcionar una solución para resolver el problema. + +## ⛓️ Dependencias / Limitaciones + +- ¿Cuáles son las dependencias de su proyecto? +- Describe cada limitación en términos detallados pero concisos. +- Explica por qué existe cada limitación. +- Proporcione las razones por las que no se pudo superar cada limitación utilizando el método o métodos elegidos para adquirir. +- Evalúe el impacto de cada limitación en relación con los hallazgos y conclusiones generales de su proyecto, y si apropiado, describa cómo estas limitaciones podrían indicar la necesidad de realizar más investigaciones. + +## 🚀 Alcance futuro + +Escribe sobre lo que no pudiste desarrollar durante el transcurso del Hackathon; y sobre lo que puede lograr su proyecto en el futuro. + +## 🏁 Comenzando + +Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local para su desarrollo. +y fines de prueba. Consulte [implementación] (# implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo. + +### Requisitos previos + +Qué necesita para instalar el software y cómo instalarlo. + +``` +Dar ejemplos +``` + +### Instalación + +Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo. + +Di cuál será el paso + +``` +Da el ejemplo +``` + +Y repetir + +``` +hasta que termine +``` + +## 🎈 Uso + +Agregue notas sobre cómo usar el sistema. + +## ⛏️ Creado con + +- [MongoDB](https://www.mongodb.com/) - Base de datos +- [Express](https://expressjs.com/) - Marco del servidor +- [VueJs](https://vuejs.org/) - Marco web +- [NodeJs](https://nodejs.org/en/) - Entorno del servidor + +## ✍️ Autores + +- [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial +- [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español + +Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto. + +## 🎉 Agradecimientos + +- Apreciación para cualquier persona cuyo código se haya utilizado +- inspiración +- referencias diff --git a/es/README_TEMPLATES/Minimal.md b/es/README_TEMPLATES/Minimal.md index e69de29..e279822 100644 --- a/es/README_TEMPLATES/Minimal.md +++ b/es/README_TEMPLATES/Minimal.md @@ -0,0 +1,46 @@ +# Título del Proyecto + +## Tabla de contenido + ++ [Acerca de](#about) ++ [Introducción](#getting_started) ++ [Uso](#usage) ++ [Contribuyendo](../CONTRIBUTING.md) + +## Acerca de + +Escribe entre 1 y 2 párrafos que describan el propósito de tu proyecto. + +## Comenzando + +Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo. + +### Requisitos previos + +Qué necesita para instalar el software y cómo instalarlo. + +``` +Dar ejemplos +``` + +### Instalación + +Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo. + +Di cuál será el paso + +``` +Da el ejemplo +``` + +Y repetir + +``` +hasta que termine +``` + +Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración. + +## Uso + +Agregue notas sobre cómo usar el sistema. diff --git a/es/README_TEMPLATES/README.md b/es/README_TEMPLATES/README.md index 414d525..47e9b70 100644 --- a/es/README_TEMPLATES/README.md +++ b/es/README_TEMPLATES/README.md @@ -1,4 +1,4 @@ -### This folder contains various README Templates that one can use based on the type of project. +### Esta carpeta contiene varias plantillas README que se pueden utilizar según el tipo de proyecto. 1. [Bot.md](/README%20Templates/Bot.md) - 2. [Hackathon.md](/README%20Templates/Hackathon.md) - diff --git a/es/README_TEMPLATES/Standard.md b/es/README_TEMPLATES/Standard.md index e69de29..214e080 100644 --- a/es/README_TEMPLATES/Standard.md +++ b/es/README_TEMPLATES/Standard.md @@ -0,0 +1,115 @@ +

+ + Project logo +

+ +

Título del proyecto

+ +
+ + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

Pocas líneas que describen su proyecto. +
+

+ +## 📝 Tabla de contenido + +- [Acerca de](#about) +- [Introducción](#Getting_started) +- [Implementación](#implementación) +- [Uso](#uso) +- [Construido con](#built_using) +- [TODO](../TODO.md) +- [Contribuyendo](../CONTRIBUTING.md) +- [Autores](#autores) +- [Agradecimientos](#reconocimiento) + +## 🧐 Acerca de + +Escribe entre 1 y 2 párrafos que describan el propósito de tu proyecto. + +## 🏁 Comenzando + +Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo. + +### Requisitos previos + +Qué necesita para instalar el software y cómo instalarlo. + +``` +Dar ejemplos +``` + +### Instalación + +Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo. + +Di cuál será el paso + +``` +Da el ejemplo +``` + +Y repetir + +``` +hasta que termine +``` + +Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración. + +## 🔧 Ejecutando las pruebas + +Explique cómo ejecutar las pruebas automatizadas para este sistema. + +### Desglosar en pruebas de un extremo a otro + +Explique qué prueban estas pruebas y por qué + +``` +Dar un ejemplo +``` + +### Y pruebas de estilo de codificación + +Explique qué prueban estas pruebas y por qué + +``` +Dar un ejemplo +``` + +## 🎈 Uso + +Agregue notas sobre cómo usar el sistema. + +## 🚀 Implementación + +Agregue notas adicionales sobre cómo implementar esto en un sistema en vivo. + +## ⛏️ Creado con + +- [MongoDB](https://www.mongodb.com/) - Base de datos +- [Express](https://expressjs.com/) - Marco del servidor +- [VueJs](https://vuejs.org/) - Marco web +- [NodeJs](https://nodejs.org/en/) - Entorno del servidor + +## ✍️ Autores + +- [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial +- [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español + +Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto. + +## 🎉 Agradecimientos + +- Apreciación para cualquier persona cuyo código se haya utilizado +- inspiración +- referencias diff --git a/es/TODO.md b/es/TODO.md index f484282..348af66 100644 --- a/es/TODO.md +++ b/es/TODO.md @@ -2,5 +2,8 @@ --- -- [ ] переводить шаблоны - +- [x] Documentar el archivo README.md en el folder de [README_TEMPLATES](./README_TEMPLATES). +- [ ] Hacer una plantilla de IoT (Usar como referencia la de documentación de los varios proyectos de Arduino). Esta plantilla debe de ser detallada e ir a profundidad a la terminologia de hardware. +- [ ] Hacer una plantilla minimalista de IOT. +- [ ] Añadir archivo COMMIT_MESSAGE_GUIDELINES.md. +- [ ] Traducir las plantillas de [plantillas](https://github.com/kylelobo/The-Documentation-Compendium#templates) a los idiomas de - chino, francés, alemán, hindi, italiano, japonés, coreano, portugués, ruso, español, etc. \ No newline at end of file