├── Revisión-de-repos
├── PT_Informe-Ux-opcional.md
├── Informe-Ux-opcional.md
├── PT_issue-licenciamiento.md
├── issue-licenciamiento.md
├── PT_issue-opcional-guia-instalación.md
├── issue-opcional-guia-instalación.md
├── PT_contenido-vitrinas.md
├── contenido-vitrinas.md
├── PT_issue-evaluacion-tecnica.md
├── issue-evaluacion-tecnica.md
├── PT_Pull-Request-Readme.md
├── Pull-Request-Readme.md
├── PT_Issue-documentacion.md
└── Issue-documentacion.md
├── docs
├── PULL_REQUEST_TEMPLATE.md
└── issue_template.md
├── sonar-project.properties
├── .github
└── workflows
│ └── build.yml
├── CONTRIBUTING.md
├── CODE-OF-CONDUCT.md
├── README-EN.md
├── README.md
├── README-PT.md
├── LICENSE-en.md
└── LICENSE.md
/Revisión-de-repos/PT_Informe-Ux-opcional.md:
--------------------------------------------------------------------------------
1 | ## Objetivo:
2 | Fazer um relatório de recomendações para a experiência do usuário das ferramentas.
3 | - A estrutura fica a critério dos laboratórios.
4 |
5 | Se você tiver ideias sobre isso, comunique-as ao usuário do Code for Development no Slack.
6 |
--------------------------------------------------------------------------------
/Revisión-de-repos/Informe-Ux-opcional.md:
--------------------------------------------------------------------------------
1 | ## Objetivo:
2 | Hacer un informe de recomendaciones a la experiencia de usuario de las herramientas.
3 | - La estructura queda a criterio de las laboratorians.
4 |
5 | De tener ideas sobre esto comunicarlas al usuario de Código para el Desarrollo en el Slack.
6 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_issue-licenciamiento.md:
--------------------------------------------------------------------------------
1 | ### Esta edição faz parte do processo de revisão da Laboratoria Code Squads novembro 2020 da iniciativa Code for Development do @EL-BID.
2 | ____
3 |
4 | ## Issue de licenciamento
5 |
6 | - [ ] Adicionar licença de código aberto. Sugerimos rever o site https://choosealicense.com/
7 |
--------------------------------------------------------------------------------
/Revisión-de-repos/issue-licenciamiento.md:
--------------------------------------------------------------------------------
1 | ### Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo del @EL-BID.
2 | ____
3 |
4 | ## Issue de licenciamiento
5 |
6 | - [ ] Agregar licencia open source. Sugerimos revisar la web https://choosealicense.com/
7 |
--------------------------------------------------------------------------------
/docs/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | ## Propuesta
2 | _Describe el problema o funcionalidad que has añadido al repositorio y el link al Issue que has creado_
3 |
4 | ## Descripción de la mejora
5 | _Describe qué has cambiado en el código y por qué eso mejora la herramienta_
6 |
7 | _Links a entradas de blogs, librerías o recursos que has utilizado_
8 |
9 |
--------------------------------------------------------------------------------
/sonar-project.properties:
--------------------------------------------------------------------------------
1 | sonar.projectKey=EL-BID_Plantilla-de-repositorio
2 | sonar.organization=el-bid
3 |
4 | # This is the name and version displayed in the SonarCloud UI.
5 | #sonar.projectName=Plantilla-de-repositorio
6 | #sonar.projectVersion=1.0
7 |
8 |
9 | # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
10 | #sonar.sources=.
11 |
12 | # Encoding of the source code. Default is default system encoding
13 | #sonar.sourceEncoding=UTF-8
14 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_issue-opcional-guia-instalación.md:
--------------------------------------------------------------------------------
1 | ### Especificação do issue no guia de instalação:
2 | Se você tentou instalar a ferramenta e teve problemas, recomendamos que documente esse problema e explique com precisão quais especificações impediram você de concluir a instalação.
3 |
4 | O objetivo deste problema é melhorar o guia de instalação.
5 |
6 | ### Contexto
7 | Como esse problema afetou você? O que você está tentando realizar?
8 | Fornecer contexto nos ajuda a encontrar uma solução mais útil no mundo real
9 |
10 | ### Ambiente
11 | * Versão utilizada:
12 | * Nome e versão do navegador:
13 | * Sistema operacional e versão (desktop ou mobile):
14 | * capturas de tela
15 |
--------------------------------------------------------------------------------
/Revisión-de-repos/issue-opcional-guia-instalación.md:
--------------------------------------------------------------------------------
1 | ### Especificación de issue en la guía de instalación:
2 | Si trataste de instalar la herramienta y tuviste problemas, te recomendamos documentar este problema y explicar de manera precisa las especificaciones que te impidieron completar la instalación.
3 |
4 | El objetivo de este issue es mejorar la guía de instalación.
5 |
6 | ### Contexto
7 | ¿Cómo te ha afectado este problema? ¿Qué estás tratando de lograr?
8 | Proporcionar contexto nos ayuda a encontrar una solución que sea más útil en el mundo real
9 |
10 | ### Environment
11 | * Versión usada:
12 | * Nombre del browser y versión:
13 | * Sistema operativo y versión (desktop o mobil):
14 | * screenshots
15 |
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: Build
2 | on:
3 | push:
4 | branches:
5 | - master
6 | pull_request:
7 | types: [opened, synchronize, reopened]
8 | jobs:
9 | sonarcloud:
10 | name: SonarCloud
11 | permissions:
12 | contents: read
13 | runs-on: ubuntu-latest
14 | steps:
15 | - uses: actions/checkout@v3
16 | with:
17 | fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
18 | - name: SonarCloud Scan
19 | uses: SonarSource/sonarcloud-github-action@master
20 | env:
21 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
22 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
23 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_contenido-vitrinas.md:
--------------------------------------------------------------------------------
1 | ### Estas são indicações e recomendações para gerar conteúdo para as vitrines das ferramentas a serem revisadas no âmbito da Laboratoria Code Squads novembro 2020 da iniciativa Code for Development.
2 |
3 | ## Valide a dica de ferramenta:
4 |
5 | O trabalho dos laboratórios é coletar informações sobre as ferramentas para que posteriormente um membro da equipe do Code for Development possa gerar a vitrine no site oficial.
6 | Para isso precisamos que eles validem as informações com as equipes, seja via slack nos canais já criados ou um google docs compartilhado.
7 |
8 | ## Preencha o formulário:
9 | Por fim, com as informações validadas, preencha o formulário para canalizar a criação da vitrine dentro do catálogo oficial.
10 |
11 | Formulário: https://airtable.com/shrArWcs0qWE7G6Up
12 |
--------------------------------------------------------------------------------
/Revisión-de-repos/contenido-vitrinas.md:
--------------------------------------------------------------------------------
1 | ### Estas son indicaciones y recomendaciones para generar contenido para las vitrinas de las herramientas a revisar en el marco del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo.
2 |
3 | ## Valida la información sobre las herramientas:
4 |
5 | El trabajo de las laboratorians es el de recopilar información sobre las herramientas para que luego un miembro del equipo de Código para el Desarrollo pueda generar la vitrina en la web oficial.
6 | Para esto necesitamos que validen con los equipos la información ya sea vía slack en los canales ya creados o un google docs compartido.
7 |
8 | ## Llena el formulario:
9 | Finalmente con la información validada llenar el formulario para poner en pipeline la creación de la vitrina dentro del catálogo oficial.
10 |
11 | Form: https://airtable.com/shrArWcs0qWE7G6Up
12 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_issue-evaluacion-tecnica.md:
--------------------------------------------------------------------------------
1 | ### Esta edição faz parte do processo de revisão da Laboratoria Code Squads Novembro 2020 da iniciativa Code for Development of @EL-BID.
2 |
3 | ## Issue de revisão de avaliação técnica:
4 |
5 | Ao comparar as informações apresentadas no repositório oficial com os campos solicitados no modelo README.md, encontramos os seguintes pontos a melhorar:
6 |
7 | - [ ] Adicione o microsserviço de relatório de avaliação estática do código Sonarcloud, levando em consideração que as condições ideais de relatório são:
8 |
9 | 1 Ausência de falhas estruturais
10 | 2 Menos de 25% de linhas duplicadas
11 | 3 Menos de 10 problemas críticos
12 | 4 Mais de 50% das classes, interfaces e métodos documentados
13 | 5 Dúvida técnica inferior a 30 dias
14 | 6 Cobertura de teste superior a 25%
15 |
16 | Isso é validado automaticamente quando você executa o relatório de confirmação mais recente do repositório.
17 |
18 | - [ ] Adicione o badge no markdown deste serviço visível no readme.md.
19 |
20 | - [ ] Adicione um microsserviço de integração contínua de código, recomendamos o Travis CI (opcional).
21 |
22 | - [ ] Adicione o badge de microsserviço de integração contínua de código visível no readme.md. A compilação deve estar em estado de passing. (opcional).
23 |
24 | - [ ] Atualize a versão de todas as dependências.
25 |
26 | ## Caso de uso deste modelo:
27 | https://github.com/datauy/ElijoEstudiar/issues/103
28 |
--------------------------------------------------------------------------------
/Revisión-de-repos/issue-evaluacion-tecnica.md:
--------------------------------------------------------------------------------
1 | ### Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el desarrollo del @EL-BID.
2 |
3 | ## Issue de revisión de evaluación técnica:
4 |
5 | Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de README.md hemos encontrado los siguiente puntos a mejorar:
6 |
7 | - [ ] Agregar el microservicio de reportes de evaluación estática de código de Sonarcloud, teniendo en cuenta que las condiciones ideales de los reportes son:
8 |
9 | 1 Ausencia de fallos estructurales
10 | 2 Menos del 25% de líneas duplicadas
11 | 3 Menos de 10 problemas críticos
12 | 4 Más del 50% de clases, interfaces y métodos documentados
13 | 5 Deuda técnica menor a 30 días
14 | 6 Cobertura de test más del 25%
15 |
16 | Esto se valida automáticamente cuando corre el reporte del último commit del repositorio.
17 |
18 | - [ ] Agregar el badge en markdown de este servicio visible en el readme.md.
19 |
20 | - [ ] Agregar un microservicio de integración continua de código, recomendamos Travis CI (opcional).
21 |
22 | - [ ] Agregar el badge del microservicio de integración continua de código visible en el readme.md. El build debe estar en estado passing.(opcional).
23 |
24 | - [ ] Actualizar versión de todas las dependencias.
25 |
26 | ## Caso de uso de este template:
27 | https://github.com/datauy/ElijoEstudiar/issues/103
28 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_Pull-Request-Readme.md:
--------------------------------------------------------------------------------
1 | ### Estas são indicações e recomendações para gerar um Pull Request (PR) no âmbito da Laboratoria Code Squads novembro 2020 da iniciativa Code for Development.
2 |
3 | ## Antes de gerar um PR:
4 |
5 | Recomendamos que você gere os issues de revisão nos repositórios oficiais das ferramentas antes de gerar um PR.
6 | Consulte o readme do repositório https://github.com/EL-BID/Repository-template/blob/master/README.md para referência.
7 | Somente depois disso os laboratórios podem gerar um pull request para ajudar a melhorar os readmes das ferramentas atribuídas.
8 |
9 | ## Passo a passo:
10 |
11 | Siga este tutorial para gerar um PR em um repositório aberto no GitHub:
12 | https://www.youtube.com/watch?v=_M8oalUyz10
13 |
14 | O Pull Request pode ser um trabalho iterativo com a equipe técnica da ferramenta.
15 | Os pontos de atualização serão feitos de acordo com as capacidades dos Laboratórios.
16 |
17 | ## Recomendações:
18 |
19 | Quando você finalmente tiver uma versão final do PR, recomendamos o seguinte:
20 | - Deixar claros os pontos de melhoria apontados pelos Laboratoristas.
21 | - Marque a conta @knlopenknowledge e @EL-BID
22 | - Rotular o problema de documentação para o qual este PR estaria contribuindo.
23 |
24 | ## Exemplo de solicitação pull:
25 | [PR para melhorar o Readme da ferramenta Eu escolho estudar](https://github.com/datauy/ElijoEstudiar/pull/104/commits/0fd5cce225f5bda792697c4518601828e2269f83?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5)
26 |
--------------------------------------------------------------------------------
/Revisión-de-repos/Pull-Request-Readme.md:
--------------------------------------------------------------------------------
1 | ### Estas son indicaciones y recomendaciones para generar un Pull Request(PR) en el marco del Laboratory Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo.
2 |
3 | ## Antes de generar un PR:
4 |
5 | Recomendamos que generen los issues de revisión en los repos oficiales de las herramientas antes de generar un PR.
6 | Ver el readme de la plantilla de repositorio https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/README.md como referencia.
7 | Solo después de esto las laboratorians pueden generar un pull request para ayudar a mejorar los readmes de las herramientas asignadas.
8 |
9 | ## Tutorial:
10 |
11 | Seguir este tutorial para generar un PR en un repositorio abierto en GitHub:
12 | https://www.youtube.com/watch?v=_M8oalUyz10
13 |
14 | El Pull Request puede ser un trabajo iterativo con el equipo técnico de la herramienta.
15 | Los puntos de mejora serán realizados bajo las capacidades de las Laboratorians.
16 |
17 | ## Recomendaciones:
18 |
19 | Cuando finalmente tengan una versión final del PR recomendamos lo siguiente:
20 | - Dejar claro los puntos de mejora realizado por las Laboratorians.
21 | - Etiquetar la cuenta @knlopenknowledge y a @EL-BID
22 | - Etiquetar el issue de documentación al que este PR estaría contribuyendo a ser cerrado.
23 |
24 | ## Ejemplo de Pull Request:
25 | [PR para mejorar el Readme de la herramienta Elijo Estudiar](https://github.com/datauy/ElijoEstudiar/pull/104/commits/0fd5cce225f5bda792697c4518601828e2269f83?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5)
26 |
--------------------------------------------------------------------------------
/docs/issue_template.md:
--------------------------------------------------------------------------------
1 |
2 | ## Español
3 |
4 | #### Descripción
5 | Una descripción clara y concisa del problema.
6 |
7 | #### Imágenes
8 |
9 |
10 | #### Archivos
11 | Una lista de archivos relevantes para este problema. Esto ayudará a las personas a navegar por el proyecto y ofrecer algunas pistas sobre dónde empezar.
12 |
13 | #### Reproducir el problema
14 | Si este problema describe un error, incluye algunos pasos para reproducir el comportamiento.
15 |
16 | #### Tareas
17 | Incluya tareas específicas en el orden en que deben realizarse. Incluya enlaces a líneas de código específicas donde la tarea debería realizarse.
18 | - [ ] Tarea 1
19 | - [ ] Tarea 2
20 | - [ ] Tarea 3
21 |
22 | #### Especificaciones
23 | ¿Dónde ocurrió el error?
24 | - Navegador y versión:
25 | - Sistema operativo en el que se presentó el problema:
26 |
27 | Recuerde usar etiquetas e hitos útiles.
28 | ___
29 |
30 | ## English
31 |
32 | #### Description
33 | A clear and concise description of what the issue is about.
34 |
35 | #### Screenshots
36 |
37 |
38 | #### Files
39 | A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start.
40 |
41 | #### To Reproduce
42 | If this issue is describing a bug, include some steps to reproduce the behavior.
43 |
44 | #### Tasks
45 | Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at.
46 | - [ ] Task 1
47 | - [ ] Task 2
48 | - [ ] Task 3
49 |
50 | #### Specifications
51 | Where did the problem occur?
52 | - Browser and version:
53 | - Operating system in which the problem was presented:
54 |
55 | Remember to use helpful labels and milestones.
56 |
57 |
--------------------------------------------------------------------------------
/Revisión-de-repos/PT_Issue-documentacion.md:
--------------------------------------------------------------------------------
1 | ### Esta edição faz parte do processo de revisão da Laboratoria Code Squads novembro 2020 da iniciativa Code for Development de @EL-BID
2 |
3 | ## Problema de revisão de documentação - readme.md:
4 |
5 | Tendo contrastado as informações apresentadas no repositório oficial com os campos solicitados no modelo de [readme.md](https://github.com/EL-BID/Temptilla-de-repositorio/blob/master/README.md) encontraram os seguintes pontos para melhorar:
6 |
7 | - [x] Adicione o logotipo para identificar o projeto.
8 | - [ ] Adicione uma imagem ou gif do projeto para identificar sua principal funcionalidade.
9 | - [ ] Incluir badges com o estado de desenvolvimento, licença, versão, cobertura, social ou outros. Esta ferramenta pode ser útil: https://shields.io/ (tutorial recomendado: https://www.youtube.com/watch?v=SIh5MQoQLPs)
10 | - [ ] Forneça uma tabela com links para cada seção para funcionar como um índice.
11 | - [ ] Especifique os pré-requisitos necessários para executar o projeto (ambiente, bibliotecas, dependências, entre outros), e forneça comandos de instalação para eles.
12 | - [ ] Especifique se as variáveis de ambiente são necessárias e em qual parte da arquitetura elas são colocadas.
13 | - [ ] Adicione uma lista de etapas que permitam a instalação e utilização do projeto localmente.
14 | - [ ] Adicione o comando de execução para testes de unidade.
15 | - [ ] Mencione as tecnologias utilizadas e adicione links referentes à documentação de cada uma.
16 | - [ ] Se necessário, adicione trechos de código com exemplos de uso.
17 | - [ ] Adicionar seção de autores.
18 | - [ ] Adicione uma seção com o processo detalhado para contribuir com o projeto.
19 | - [ ] Adicione uma seção especificando a licença de código aberto que está sendo usada redirecionando para o arquivo LICENSE.md.
20 |
21 |
22 | ### Caso de uso deste modelo:
23 | https://github.com/datauy/ElijoEstudiar/issues/102
24 |
--------------------------------------------------------------------------------
/Revisión-de-repos/Issue-documentacion.md:
--------------------------------------------------------------------------------
1 | ### Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo de @EL-BID
2 |
3 | ## Issue de revisión de documentación - readme.md:
4 |
5 | Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de [readme.md](https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/README.md) hemos encontrado los siguiente puntos a mejorar:
6 |
7 | - [ ] Agregar el logo para identificar el proyecto.
8 | - [ ] Agregar una imagen o gif del proyecto para identificar su funcionalidad principal.
9 | - [ ] Incluir badges con el estado de desarrollo, licencia, versión, coverage, sociales u otras. Esta herramienta puede ser de utilidad: https://shields.io/ (tutorial recomendado: https://www.youtube.com/watch?v=SIh5MQoQLPs)
10 | - [ ] Proporcionar una tabla de contenidos con links para cada apartado para que funcione como índice.
11 | - [ ] Especificar los pre-requisitos necesarios para ejecutar el proyecto (environment, librerías, dependencias, entre otros), y proporcionar comandos de instalación de los mismos.
12 | - [ ] Precisar si se requieren variables de entorno y en qué parte de la arquitectura se colocan.
13 | - [ ] Añadir una serie de pasos que permitan la instalación y uso del proyecto de forma local.
14 | - [ ] Añadir comando de ejecución para pruebas unitarias.
15 | - [ ] Hacer mención de las tecnologías utilizadas y añadir enlaces haciendo referencia a la documentación de cada una.
16 | - [ ] Si es preciso, añadir fragmentos de código con ejemplos de uso.
17 | - [ ] Añadir sección autor@s.
18 | - [ ] Añadir un apartado con el proceso detallado para contribuir al proyecto.
19 | - [ ] Añadir un apartado especificando la licencia open source que se esté usando redirigiendo al archivo LICENSE.md.
20 |
21 |
22 | ### Caso de uso de este template:
23 | https://github.com/datauy/ElijoEstudiar/issues/102
24 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | ## Por qué contribuir
2 |
3 | Si has llegado hasta aquí es porque posiblemente estás pensando en contribuir a algún proyecto de [Código para el Desarrollo](https://knowledge.iadb.org/es/codigo-para-el-desarrollo).
4 |
5 | Código para el Desarrollo es el portal del **Banco Interamericano de Desarrollo** que te permite explorar y reutilizar herramientas digitales de código abierto, que pueden ser utilizadas en la implementación de los programas y proyectos para el desarrollo económico y social de los países de América Latina y el Caribe.
6 |
7 | En el BID entendemos el código como un bien de conocimiento que debe ser abierto a los ciudadanos y gobiernos de la región, por eso intentamos que, en la medida de lo posible, las herramientas digitales que tengan potencial de mejorar vidas en la región estén publicadas en la cuenta oficial de [@El-BID](github.com/el-bid) en Github.
8 |
9 | De la misma manera, incentivamos a aquellas personas que contribuyan a la mejora de estas herramientas digitales, a devolver esas contribuciones al bien público. Por supuesto, en ese caso, quedará tu nombre registrado en la lista de atribuciones.
10 |
11 | ## Cómo contribuir
12 |
13 | Si al reutilizar este código consideras que:
14 |
15 | - Has añadido alguna nueva funcionalidad con la que agregas valor para que más personas la reutilicen,
16 | - Has hecho más versátil la herramienta para que sea compatible con nuevas actualizaciones,
17 | - Has solucionado algún fallo existente,
18 | - O simplemente has mejorado la interfaz de usuario o documentación del mismo.
19 |
20 | Entonces te animamos a que devuelvas al repositorio los avances realizados.
21 |
22 | Sigue los siguientes pasos para hacer una contribución a la herramienta digital:
23 |
24 | 1. Haz un fork del repositorio.
25 | 2. Desarrolla la nueva funcionalidad o los haz los cambios que creas que agregan valor a la herramienta
26 | 3. Haz un "pull request" documentando detalladamente los cambios propuestos en el repositorio.
27 |
28 | **Si no has contribuido al repositorio, pero la herramienta te ha sido útil, nos encantaría escuchar la experiencia. Cuéntanos tu experiencia en un Issue o a través del email de code@iadb.org**
29 |
30 | #### Atribuciones
31 | Dinos en el "pull request" tu nombre de usuario y organización para añadirlo a la lista de contribuciones en el Readme.md.
32 |
33 | ## Código de conducta
34 |
35 | Este proyecto tiene un [Código de Conducta](https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/CODE-OF-CONDUCT.md). Esperamos que todos los que participen estén conformes con él. Lee el código para saber qué esperamos de los contribuidores.
36 |
37 | ## Limitación de responsabilidades
38 |
39 | El BID no será responsable, bajo circunstancia alguna, de daño ni indemnización, moral o patrimonial; directo o indirecto; accesorio o especial; o por vía de consecuencia, previsto o imprevisto, que pudiese surgir:
40 |
41 | i. Bajo cualquier teoría de responsabilidad, ya sea por contrato, infracción de derechos de propiedad intelectual, negligencia o bajo cualquier otra teoría; y/o
42 |
43 | ii. A raíz del uso de la Herramienta Digital, incluyendo, pero sin limitación de potenciales defectos en la Herramienta Digital, o la pérdida o inexactitud de los datos de cualquier tipo. Lo anterior incluye los gastos o daños asociados a fallas de comunicación y/o fallas de funcionamiento de computadoras, vinculados con la utilización de la Herramienta Digital.
44 |
--------------------------------------------------------------------------------
/CODE-OF-CONDUCT.md:
--------------------------------------------------------------------------------
1 | *Este es un ejemplo de Código de Conducta que se ha usado en más de 30.000 proyectos de código abierto. Es una adaptación del [Contributor Covenant][homepage], versión 1.4, disponible en [http://contributor-covenant.org/version/1/4/es/][version].*
2 |
3 | # Código de Conducta convenido para Contribuyentes
4 |
5 | ## Nuestro compromiso
6 |
7 | En el intento de fomentar una comunidad abierta y acogedora donde se reconozca el trabajo de todos, nosotros como contribuyentes y administradores nos comprometemos a hacer de la participación en nuestro proyecto y nuestra comunidad una experiencia libre de acoso para todos, independientemente de la edad, dimensión corporal, discapacidad, etnia, identidad y expresión de género, nivel de experiencia, nacionalidad, apariencia física, raza, religión, identidad u orientación sexual.
8 |
9 | ## Nuestros estándares
10 |
11 | Ejemplos de comportamiento que contribuyen a crear un ambiente positivo:
12 |
13 | * Uso de lenguaje amable e inclusivo
14 | * Respeto a diferentes puntos de vista y experiencias
15 | * Aceptación de críticas constructivas
16 | * Enfocarse en lo que es mejor para la comunidad
17 | * Mostrar empatía a otros miembros de la comunidad
18 |
19 | Ejemplos de comportamiento inaceptable por participantes:
20 |
21 | * Uso de lenguaje o imágenes sexuales y atencián sexual no deseada
22 | * Comentarios insultantes o despectivos (*trolling*) y ataques personales o políticos
23 | * Acoso público o privado
24 | * Publicación de información privada de terceros sin su consentimiento, como direcciones físicas o electrónicas
25 | * Otros tipos de conducta que pudieran considerarse inapropiadas en un entorno profesional.
26 |
27 | ## Nuestras responsabilidades
28 |
29 | Los administradores del proyecto son responsables de clarificar los estándares de comportamiento aceptable y se espera que tomen medidas correctivas y apropiadas en respuesta a situaciones de conducta inaceptable.
30 |
31 | Los administradores del proyecto tienen el derecho y la responsabilidad de eliminar, editar o rechazar comentarios, *commits*, código, ediciones de documentación, *issues*, y otras contribuciones que no están alineadas con este Código de Conducta, o de prohibir temporal o permanentemente a cualquier colaborador cuyo comportamiento sea inapropiado, amenazante, ofensivo o perjudicial.
32 |
33 | ## Alcance
34 |
35 | Este código de conducta aplica tanto a espacios del proyecto como a espacios públicos donde un individuo está en representación del proyecto o comunidad. Ejemplos de esto incluye el uso de la cuenta oficial de correo electrónico, publicaciones a través de las redes sociales oficiales, o presentaciones con personas designadas en eventos *online* u *offline*. La representación del proyecto puede ser clarificada explicitamente por los administradores del proyecto.
36 |
37 | ## Aplicación
38 |
39 | Ejemplos de abuso, acoso u otro tipo de comportamiento inaceptable puede ser reportado al equipo del proyecto en code@iadb.org . Todas las quejas serán revisadas e investigadas, generando un resultado apropiado a las circunstancias. El equipo del proyecto está obligado a mantener confidencialidad de la persona que reporta el incidente. Detalles específicos acerca de las políticas de aplicación pueden ser publicadas por separado.
40 |
41 | Administradores que no sigan o que no hagan cumplir este Código de Conducta pueden ser eliminados de forma temporal o permanente del equipo administrador.
42 |
43 | ## Atribución
44 |
45 | Este Código de Conducta es una adaptación del [Contributor Covenant][homepage], versión 1.4, disponible en [http://contributor-covenant.org/version/1/4/es/][version]
46 |
47 | [homepage]: http://contributor-covenant.org
48 | [version]: http://contributor-covenant.org/version/1/4/es/
49 |
--------------------------------------------------------------------------------
/README-EN.md:
--------------------------------------------------------------------------------
1 | [](https://github.com/EL-BID/Plantilla-de-repositorio/)
2 |
3 | ## Digital Tools Use and Support Documentation Template - README.md
4 | This is a template based on the standards of the IDB Digital Tools Publication Guide. We know that there is no single standard for supporting documentation and use of digital tools, but we have compiled these important characteristics that a readme.md should have to facilitate their use and amplify their potential impact. Any comment or recommendation, yo can create an issue or write to us directly at code@iadb.org.
5 |
6 | ## Template starts here 👇
7 |
8 |
9 | * This digital tool is part of the catalog of tools of the **Inter-American Development Bank**. You can learn more about the IDB initiative at [https://knowledge.iadb.org/en/code-development](https://knowledge.iadb.org/en/code-development) *
10 |
11 | Tool name
12 | Logo and image or gif of the main interface of the tool
13 | 
14 |
15 | ## Table of Contents:
16 | ---
17 |
18 | - [Badges or shields](#badges-or-shields)
19 | - [Description and context](#description-and-context)
20 | - [User's Guide](#users-guide)
21 | - [Installation guide](#installation-guide)
22 | - [How to contribute](#how-to-contribute)
23 | - [Code of conduct](#code-of-conduct)
24 | - [Author/s](#authors)
25 | - [Additional Information](#additional-information)
26 | - [License](#license)
27 | - [Limitation of responsibilities](#limitation-of-responsibilities)
28 |
29 |
30 | ## Badges or shields
31 | ---
32 | It is common in many open source repositories to use badges or shields to give visibility to the use of microservices, licenses, downloads, etc. We recommend reviewing the https://shields.io/ initiative where, as you deem necessary, you can generate badges for your repo.
33 |
34 | ### Badge examples
35 |
36 | - code coverage percentage: 
37 | - stable release version: 
38 | - package manager release: 
39 | - status of third-party dependencies: 
40 | - static code analysis grade: 
41 | - [SemVer](https://semver.org/) version observance: 
42 | - amount of [Liberapay](https://liberapay.com/) donations per week: 
43 | - Python package downloads: 
44 | - Chrome Web Store extension rating: 
45 | - [Uptime Robot](https://uptimerobot.com) percentage: 
46 |
47 |
48 | ### Badges we request:
49 | ---
50 | In the Code for Development initiative, we ask the teams that add their tools to the catalog to add the badge generated by the use of the SonarCloud static code evaluation microservice.
51 |
52 | The badge looks like this and redirects to the static evaluation report of the last commit of the tool:
53 |
54 | [](https://sonarcloud.io/dashboard?id=EL-BID_guia-de-publicacion)
55 |
56 |
57 | ## Description and context
58 | ---
59 | This is a README file. It must contain the supporting documentation for the use of the digital tool. The following sections are the recommended sections that you should include in any digital tool. You can download this file to serve as a template.
60 |
61 | Be sure to start this file with a brief description of the functionalities and context of the digital tool. Be concise and to the point.
62 |
63 | ## User's Guide
64 | ---
65 | Explains the basic steps on how to use the digital tool. It is a good section to show screenshots or gifs to help you understand the digital tool.
66 |
67 | ## Installation guide
68 | ---
69 | Step by step of how to install the digital tool. In this section it is recommended to explain the architecture of folders and modules that make up the system.
70 |
71 | Depending on the type of digital tool, the level of complexity may vary. On some occasions it may be necessary to install components that are dependent on the digital tool. If this is the case, add the following section as well.
72 | The installation guide should specifically contain:
73 | - The operating system requirements for the compilation (specific versions of libraries, package and dependency management software, SDKs and compilers, etc.).
74 | - The project's own dependencies, both external and internal (order of compilation of sub-modules, configuration of the location of dynamic libraries, etc.).
75 | - Specific steps for compiling the source code and executing unit tests if the project has them.
76 |
77 | ### Dependencies
78 | Description of the external resources that generate a dependency for the reuse of the digital tool (libraries, frameworks, access to databases and licenses for each resource). It is good practice to describe the latest versions that the digital tool has been tested on.
79 |
80 | You can use this font style to differentiate the installation commands.
81 |
82 | ## How to contribute
83 | ---
84 | This section explains to developers the common ways to submit a pull requests, how to declare bugs in the tool, and what style guides to use when writing more lines of code. You can also make a list of points that can be improved in your code to create ideas for improvement.
85 |
86 | ## Code of conduct
87 | ---
88 | The code of conduct establishes the social norms, rules and responsibilities that individuals and organizations must follow when interacting in any way with the digital tool or their community. It is good practice to create an environment of respect and inclusion in contributions to the project.
89 |
90 | The Github platform rewards and helps repositories have this file. When creating CODE_OF_CONDUCT.md you can start from a template suggested by them. You can read more about how to create a Code of Conduct file (here) [https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/]
91 |
92 | ## Author/s
93 | ---
94 | Name the original author / s. Check with them before posting an email or personal name. A very common way is to direct them to your social media accounts.
95 |
96 | ## Additional Information
97 | ---
98 | This is the section that allows you to add more contextual information to the project such as a relevant website, similar projects or that have used the same technology.
99 |
100 | ## License
101 | ---
102 |
103 | The license specifies the permissions and conditions of use that the developer grants to other developers who use and / or modify the digital tool.
104 |
105 | Include in this section a note with the type of license granted to this digital tool. The license text must be included in a * LICENSE.md * or * LICENSE.txt * file at the root of the repository.
106 |
107 | If you do not know what types of licenses exist and which is the best for each case, we recommend you visit the page https://choosealicense.com/.
108 |
109 | If the tool you are publishing with the Code for Development initiative has been financed by the IDB, we invite you to review the [bank's official license to publish software] (https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/LICENSE.md)
110 |
111 | ## Limitation of responsibilities
112 | Disclaimer: This section is only for IDB-funded tools.
113 |
114 | The IDB will not be responsible, under any circumstance, for damage or compensation, moral or patrimonial; direct or indirect; accessory or special; or by way of consequence, foreseen or unforeseen, that could arise:
115 |
116 | i. Under any theory of liability, whether by contract, infringement of intellectual property rights, negligence or under any other theory; me
117 |
118 | ii. As a result of the use of the Digital Tool, including, but not limited to, potential defects in the Digital Tool, or the loss or inaccuracy of data of any kind. The foregoing includes expenses or damages associated with communication failures and / or computer malfunctions, related to the use of the Digital Tool.
119 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Plantilla de Documentación de Soporte y Uso de herramientas digitales - README.md
2 | Esta es una plantilla basada en los estándares de la Guía de publicacion de herramientas digitales del BID. Sabemos que no existe un solo estándar para la documentación de soporte y uso de herramientas digitales pero hemos recopilado estas características importantes que debe tener un readme.md para facilitar el uso y amplificar el potencial de impacto de las mismas. Cualquier comentario o recomendación les pedimos generar un issue de consulta o escribirnos directamente a code@iadb.org.
3 |
4 | ## La plantilla empieza aquí 👇
5 |
6 |
7 | *Esta herramienta digital forma parte del catálogo de herramientas del **Banco Interamericano de Desarrollo**. Puedes conocer más sobre la iniciativa del BID en [https://knowledge.iadb.org/es/codigo-para-el-desarrollo](https://knowledge.iadb.org/es/codigo-para-el-desarrollo)*
8 |
9 | Nombre de la herramienta
10 | Logo e imagen o gif de la interfaz principal de la herramienta
11 |
12 |
13 | ## Tabla de contenidos:
14 | ---
15 |
16 | - [Badges o escudos](#badges-o-escudos)
17 | - [Descripción y contexto](#descripción-y-contexto)
18 | - [Guía de usuario](#guía-de-usuario)
19 | - [Guía de instalación](#guía-de-instalación)
20 | - [Cómo contribuir](#cómo-contribuir)
21 | - [Código de conducta](#código-de-conducta)
22 | - [Autor/es](#autores)
23 | - [Información adicional](#información-adicional)
24 | - [Licencia](#licencia)
25 | - [Limitación de responsabilidades - Solo BID](#limitación-de-responsabilidades)
26 |
27 | ## Badges o escudos
28 | ---
29 | Es común en muchos repositorios open source el uso de badges o escudos para dar visbilidad el uso de microservicios, licencias, descargas, etc. Recomendamos revisar la iniciativa https://shields.io/ donde según consideres necesario podrás generar badges para tu repo.
30 |
31 | ### Ejemplos de badges
32 |
33 | - code coverage percentage: 
34 | - stable release version: 
35 | - package manager release: 
36 | - status of third-party dependencies: 
37 | - static code analysis grade: 
38 | - [SemVer](https://semver.org/) version observance: 
39 | - amount of [Liberapay](https://liberapay.com/) donations per week: 
40 | - Python package downloads: 
41 | - Chrome Web Store extension rating: 
42 | - [Uptime Robot](https://uptimerobot.com) percentage: 
43 |
44 | ### Badges que solicitamos:
45 | ---
46 | En la iniciativa Código para el Desarrollo solicitamos a los equipos que suman sus herramientas al catálogo de sumar el badge generado por el uso del microservicio de evaluación estática de código SonarCloud.
47 |
48 | El badge se ve así y redirige al reporte de evaluación estática del último commit de la herramienta:
49 |
50 | [](https://sonarcloud.io/summary/new_code?id=EL-BID_Plantilla-de-repositorio)
51 |
52 |
53 | ## Descripción y contexto
54 | ---
55 | Esto es un archivo README. Debe contener la documentación de soporte uso de la herramienta digital. Las siguientes secciones son las secciones recomendadas que debes poner incluir en cualquier herramienta digital. Puedes descargar este archivo para que te sirva como plantilla.
56 |
57 | Asegúrate de empezar este archivo con una breve descripción sobre las funcionalidades y contexto de la herramienta digital. Sé conciso y al grano.
58 |
59 | ## Guía de usuario
60 | ---
61 | Explica los pasos básicos sobre cómo usar la herramienta digital. Es una buena sección para mostrar capturas de pantalla o gifs que ayuden a entender la herramienta digital.
62 |
63 | ## Guía de instalación
64 | ---
65 | Paso a paso de cómo instalar la herramienta digital. En esta sección es recomendable explicar la arquitectura de carpetas y módulos que componen el sistema.
66 |
67 | Según el tipo de herramienta digital, el nivel de complejidad puede variar. En algunas ocasiones puede ser necesario instalar componentes que tienen dependencia con la herramienta digital. Si este es el caso, añade también la siguiente sección.
68 |
69 | La guía de instalación debe contener de manera específica:
70 | - Los requisitos del sistema operativo para la compilación (versiones específicas de librerías, software de gestión de paquetes y dependencias, SDKs y compiladores, etc.).
71 | - Las dependencias propias del proyecto, tanto externas como internas (orden de compilación de sub-módulos, configuración de ubicación de librerías dinámicas, etc.).
72 | - Pasos específicos para la compilación del código fuente y ejecución de tests unitarios en caso de que el proyecto disponga de ellos.
73 |
74 | ### Dependencias
75 | Descripción de los recursos externos que generan una dependencia para la reutilización de la herramienta digital (librerías, frameworks, acceso a bases de datos y licencias de cada recurso). Es una buena práctica describir las últimas versiones en las que ha sido probada la herramienta digital.
76 |
77 | Puedes usar este estilo de letra diferenciar los comandos de instalación.
78 |
79 | ## Cómo contribuir
80 | ---
81 | Esta sección explica a desarrolladores cuáles son las maneras habituales de enviar una solicitud de adhesión de nuevo código (“pull requests”), cómo declarar fallos en la herramienta y qué guías de estilo se deben usar al escribir más líneas de código. También puedes hacer un listado de puntos que se pueden mejorar de tu código para crear ideas de mejora.
82 |
83 | ## Código de conducta
84 | ---
85 | El código de conducta establece las normas sociales, reglas y responsabilidades que los individuos y organizaciones deben seguir al interactuar de alguna manera con la herramienta digital o su comunidad. Es una buena práctica para crear un ambiente de respeto e inclusión en las contribuciones al proyecto.
86 |
87 | La plataforma Github premia y ayuda a los repositorios dispongan de este archivo. Al crear CODE_OF_CONDUCT.md puedes empezar desde una plantilla sugerida por ellos. Puedes leer más sobre cómo crear un archivo de Código de Conducta (aquí)[https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/]
88 |
89 | ## Autor/es
90 | ---
91 | Nombra a el/los autor/es original/es. Consulta con ellos antes de publicar un email o un nombre personal. Una manera muy común es dirigirlos a sus cuentas de redes sociales.
92 |
93 | ## Información adicional
94 | ---
95 | Esta es la sección que permite agregar más información de contexto al proyecto como alguna web de relevancia, proyectos similares o que hayan usado la misma tecnología.
96 |
97 | ## Licencia
98 | ---
99 |
100 | La licencia especifica los permisos y las condiciones de uso que el desarrollador otorga a otros desarrolladores que usen y/o modifiquen la herramienta digital.
101 |
102 | Incluye en esta sección una nota con el tipo de licencia otorgado a esta herramienta digital. El texto de la licencia debe estar incluído en un archivo *LICENSE.md* o *LICENSE.txt* en la raíz del repositorio.
103 |
104 | Si desconoces qué tipos de licencias existen y cuál es la mejor para cada caso, te recomendamos visitar la página https://choosealicense.com/.
105 |
106 | Si la herramienta que estás publicando con la iniciativa Código para el Desarrollo ha sido financiada por el BID, te invitamos a revisar la [licencia oficial del banco para publicar software](https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/LICENSE.md)
107 |
108 | ## Limitación de responsabilidades
109 | Disclaimer: Esta sección es solo para herramientas financiadas por el BID.
110 |
111 | El BID no será responsable, bajo circunstancia alguna, de daño ni indemnización, moral o patrimonial; directo o indirecto; accesorio o especial; o por vía de consecuencia, previsto o imprevisto, que pudiese surgir:
112 |
113 | i. Bajo cualquier teoría de responsabilidad, ya sea por contrato, infracción de derechos de propiedad intelectual, negligencia o bajo cualquier otra teoría; y/o
114 |
115 | ii. A raíz del uso de la Herramienta Digital, incluyendo, pero sin limitación de potenciales defectos en la Herramienta Digital, o la pérdida o inexactitud de los datos de cualquier tipo. Lo anterior incluye los gastos o daños asociados a fallas de comunicación y/o fallas de funcionamiento de computadoras, vinculados con la utilización de la Herramienta Digital.
116 |
--------------------------------------------------------------------------------
/README-PT.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 | 
4 |
5 | ## Modelo de Documentação de Suporte e Uso de Ferramenta Digital - README.md
6 | Este é um modelo baseado nos padrões do Guia de Publicação de Ferramentas Digitais do BID. Sabemos que não existe um padrão único para a documentação de suporte e uso de ferramentas digitais, mas compilamos essas importantes características que um readme.md deve ter para facilitar seu uso e ampliar seu potencial impacto. Para quaisquer comentários ou recomendações, pedimos que você gere um problema de consulta ou escreva diretamente para code@iadb.org.
7 |
8 | ## O modelo começa aqui 👇
9 |
10 |
11 | *Esta ferramenta digital faz parte do catálogo de ferramentas do **Banco Interamericano de Desenvolvimento**. Você pode saber mais sobre a iniciativa do BID em [https://knowledge.iadb.org/pt-br/codigo-para-o-desenvolvimento](https://knowledge.iadb.org/pt-br/codigo-para-o-desenvolvimento)*
12 |
13 | Nome da ferramenta
14 | Logo e imagem ou gif da interface principal da ferramenta
15 |
16 |
17 | ## Tabela de conteúdos:
18 | ---
19 |
20 | - [Badges ou escudos](#badges-ou-escudos)
21 | - [Descrição e contexto](#Descrição-e-contexto)
22 | - [Guia do usuário](#Guia-do-usuário)
23 | - [Guia de instalação](#Guia-de-instalação)
24 | - [Como contribuir](#Como-contribuir)
25 | - [Código de conduta](#Código-de-conduta)
26 | - [Autor/es](#Autor(es))
27 | - [Informação adicional](#Informação-adicional)
28 | - [Licença](#Licença)
29 | - [Isenção de responsabilidade - Somente BID](#Isenção-de-responsabilidade)
30 |
31 | ## Badges ou escudos
32 | ---
33 | É comum em muitos repositórios open source usar badges ou shields para dar visibilidade ao uso de microsserviços, licenças, downloads, etc. Recomendamos revisar a iniciativa https://shields.io/ onde, conforme julgar necessário, você pode gerar badges para seu repositório.
34 |
35 | ### Exemplos de Badges
36 |
37 | - porcentagem de cobertura de código: 
38 | - versão de lançamento estável: 
39 | - versão do gerenciador de pacotes: 
40 | - status de dependências de terceiros: 
41 | - grau de análise de código estático: 
42 | - [SemVer](https://semver.org/) observância da versão: 
43 | - quantidade de [Liberapay](https://liberapay.com/) doações por semana: 
44 | - Downloads de pacotes Python: 
45 | - Classificação da extensão da Chrome Web Store: 
46 | - [Uptime Robot](https://uptimerobot.com) porcentagem: 
47 |
48 | ### Badges que solicitamos:
49 | ---
50 | Na iniciativa Code for Development, solicitamos às equipes que adicionam suas ferramentas ao catálogo que adicionem o badge gerado pelo uso do microsserviço de avaliação de código estático SonarCloud.
51 |
52 | O badge fica assim e redireciona para o relatório de avaliação estática do último commit da ferramenta:
53 |
54 | [](https://sonarcloud.io/summary/new_code?id=EL-BID_Plantilla-de-repositorio)
55 |
56 |
57 | ## Descrição e contexto
58 | ---
59 | Este é um arquivo README. Deve conter a documentação de suporte para o uso da ferramenta digital. As seções a seguir são as seções recomendadas que você deve incluir em qualquer ferramenta digital. Você pode baixar este arquivo para servir como modelo.
60 |
61 | Certifique-se de iniciar este arquivo com uma breve descrição sobre as funcionalidades e o contexto da ferramenta digital. Seja conciso e direto ao ponto.
62 |
63 | ## Guia do usuário
64 | ---
65 | Ele explica os passos básicos sobre como usar a ferramenta digital. É uma boa seção para mostrar capturas de tela ou gifs que ajudam a entender a ferramenta digital.
66 |
67 | ## Guia de instalação
68 | ---
69 | Passo a passo de como instalar a ferramenta digital. Nesta seção é recomendado explicar a arquitetura de pastas e módulos que compõem o sistema.
70 |
71 | Dependendo do tipo de ferramenta digital, o nível de complexidade pode variar. Em algumas ocasiões pode ser necessário instalar componentes dependentes da ferramenta digital. Se este for o caso, adicione a próxima seção também.
72 |
73 | O guia de instalação deve conter especificamente:
74 | - Os requisitos do sistema operacional para a compilação (versões específicas de bibliotecas, software de gerenciamento de pacotes e dependências, SDKs e compiladores, etc.).
75 | - As dependências próprias do projeto, tanto externas quanto internas (ordem de compilação dos submódulos, configuração de localização de bibliotecas dinâmicas, etc.).
76 | - Etapas específicas para a compilação do código fonte e execução de testes unitários caso o projeto os possua.
77 |
78 | ### Dependências
79 | Descrição dos recursos externos que geram dependência para a reutilização da ferramenta digital (bibliotecas, frameworks, acesso a bancos de dados e licenças para cada recurso). É uma boa prática descrever as versões mais recentes nas quais a ferramenta digital foi testada.
80 |
81 | Você pode usar este estilo de fonte para diferenciar os comandos de instalação.
82 |
83 | ## Como contribuir
84 | ---
85 | Esta seção explica aos desenvolvedores quais são as formas usuais de enviar uma nova solicitação pull de código, como declarar bugs na ferramenta e quais guias de estilo usar ao escrever mais linhas de código. Você também pode fazer uma lista de pontos que podem ser melhorados em seu código para criar ideias de melhoria.
86 |
87 | ## Código de conduta
88 | ---
89 | O código de conduta estabelece as normas sociais, regras e responsabilidades que indivíduos e organizações devem seguir ao interagir de qualquer forma com a ferramenta digital ou sua comunidade. É uma boa prática criar um ambiente de respeito e inclusão nas contribuições ao projeto.
90 |
91 | A plataforma Github recompensa e ajuda os repositórios a ter esse arquivo. Ao criar CODE_OF_CONDUCT.md você pode começar a partir de um template sugerido por eles. Você pode ler mais sobre como criar um arquivo de Código de Conduta (aqui)[https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/]
92 |
93 | ## Autor(es)
94 | ---
95 | Nomeie o(s) autor(es) original(is). Verifique com eles antes de postar um e-mail ou nome pessoal. Uma maneira muito comum é direcioná-los para suas contas de mídia social.
96 |
97 | ## Informação adicional
98 | ---
99 | Esta é a seção que permite adicionar mais informações de contexto ao projeto, como um site relevante, projetos semelhantes ou aqueles que usaram a mesma tecnologia.
100 |
101 | ## Licença
102 | ---
103 |
104 | A licença especifica as permissões e condições de uso que o desenvolvedor concede a outros desenvolvedores que usam e/ou modificam a ferramenta digital.
105 |
106 | Inclua nesta seção uma nota com o tipo de licença concedida a esta ferramenta digital. O texto da licença deve ser incluído em um arquivo *LICENSE.md* ou *LICENSE.txt* na raiz do repositório.
107 |
108 | Se você não sabe que tipos de licenças existem e qual é a melhor para cada caso, recomendamos que visite a página https://choosealicense.com/.
109 |
110 | Se a ferramenta que você está publicando com a iniciativa Código para o Desenvolvimento foi financiada pelo BID, convidamos você a revisar o [licença oficial do banco para publicar software](https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/LICENSE.md)
111 |
112 | ## Isenção de responsabilidade
113 | Isenção de responsabilidade: Esta seção é apenas para ferramentas financiadas pelo BID.
114 |
115 | O BID não será responsável, em hipótese alguma, por danos ou indenizações, morais ou patrimoniais; direto ou indireto; acessório ou especial; ou por consequência, prevista ou imprevista, que possa surgir:
116 |
117 | i. Sob qualquer teoria de responsabilidade, seja em contrato, violação de direitos de propriedade intelectual, negligência, ou sob qualquer outra teoria;
118 |
119 | ii. Como resultado do uso da Ferramenta Digital, incluindo, mas não limitado a, possíveis defeitos na Ferramenta Digital, ou perda ou imprecisão de dados de qualquer tipo. O anterior inclui despesas ou danos associados a falhas de comunicação e/ou mau funcionamento do computador, vinculados ao uso da Ferramenta Digital.
120 |
--------------------------------------------------------------------------------
/LICENSE-en.md:
--------------------------------------------------------------------------------
1 | ## AM-331-A3 Software License
2 | Effective: April 2018
3 | Page Content
4 |
5 | The Software, with the exception of the Support and Usage Documents, shall be subject to the following terms and conditions, which shall be packaged as part of each Software under a file bearing the name "LICENSE" :
6 | "Copyright © [year]. Inter-American Development Bank ("IDB"). Authorized Use."
7 |
8 | ### 1. License
9 | The IDB hereby grants to the user ("User") a non-exclusive, revocable, worldwide, royalty-free license ("License") to reproduce, distribute, publicly perform, lend and make available to the public, and modify the software and modifications thereto, by itself or as part of a collection, provided that it is for non-commercial purposes, subject to the terms and conditions set forth herein.
10 | Unless otherwise indicated, the Support and Use Documentation for the software is licensed under Creative Commons IGO 3.0 Attribution-NonCommercial-NoDerivs (CC-IGO 3.0 BY-NC-ND).
11 |
12 | #### 2. Definitions
13 | 2.1 Software: a set of computer programs, instructions and rules that enable tasks to be executed on a computer in order to manage a given process or obtain a given result. Software includes (i) source code, (ii) object code and (iii) Support and Usage Documentation.
14 | The Software may be of the type, but not limited to (i) computer executable program, (ii) mobile and desktop application, (iii) algorithm and (iv) spreadsheet containing macros, as well as other instructions to simulate, project or perform other calculations.
15 | 2.2 Source Code: set of lines of text containing the steps to be followed by the computer to execute the Software. It can be composed of any number of documents, with different extensions and organized in folders.
16 | 2.3 Object Code: code resulting from the compilation of the Source Code. Compilation is a computer process that translates the Source Code into machine language or bytecode.
17 | 2.4 Supporting and Usage Documentation (the "Documentation"): refers to the information accompanying the source and object code that enables a human to understand the objectives, architecture and programming language of the Software.
18 | 2.5 Derivative Software: derivative works of the Software, such as modifications, updates and upgrades thereof.
19 | 2.6 User: any person, natural or legal, who obtains a copy of the Software.
20 |
21 | ### 3. IDB's Rights
22 | 3.1 The IDB reserves all intellectual property rights, including without limitation copyrights, relating to or associated with the Software.
23 | 3.2 The IDB expressly reserves the rights to assign, transfer and/or sub-license the Software and/or any of its components to third parties without prior notice.
24 |
25 | ### 4. User's Rights on Derivative Software
26 | The User who develops Derivative Software shall retain all intellectual property rights, including without limitation copyrights, related to or associated with the Derivative Software, provided that such Derivative Software and any future releases shall be subject to the same terms and conditions of this License.
27 |
28 | ### 5. Restrictions
29 | 5.1 The User is only authorized to make use of the Software as described in this License.
30 | 5.2 Except for this License, the IDB does not grant any other license to the User with respect to any other information or works owned by the IDB or any copyrights, trademarks or any other intellectual property rights of the IDB. Any such further license must be in writing and signed by a duly authorized representative of the IDB for such purposes.
31 | 5.3 The License does not constitute a sale of the Software or any part or copy thereof.
32 | 5.4 The User may not use or permit others to use the Software for commercial purposes.
33 | 5.5 The User may only authorize use of the Software by third parties in accordance with the provisions of this License, and in no event may third parties acquire more rights to the Software than those expressly granted by the IDB under this License.
34 |
35 | ### 6. Acknowledgment
36 | 6.1 The User shall maintain the following statements and disclaimers in the Software Documentation master file:
37 | "Copyright © [year]. Inter-American Development Bank ("IDB"). Authorized Use.
38 | The procedures and results obtained based on the execution of this software are those programmed by the developers and do not necessarily reflect the views of the IDB, its Board of Executive Directors or the countries it represents."
39 | 6.1.1 In the case of Multilateral Investment Fund ("MIF") Software, the disclaimer shall be: "The opinions expressed in this work are those of the authors and do not necessarily reflect the views of the IDB, its Board of Executive Directors or the countries it represents, nor those of the MIF Donors Committee or the countries it represents".
40 | 6.2 The User may include in the Derivative Software a reference to the Software as an original work, provided that such notice does not create any confusion as to the ownership of the IDB's rights in the Software.
41 |
42 | ### IDB Name and Logo
43 | The User may not use the IDB's name and/or logo for any purpose other than as provided herein, nor may the User make any promises, commitments, obligations or warranties of any kind on behalf of the IDB.
44 |
45 | ### Representations and Warranties
46 | 8.1 The IDB grants this License without express or implied warranty of any kind, objective or subjective, in contract or tort, including, but not limited to, warranties of merchantability, fitness, suitability, compliance with standards or requirements, or fitness for a particular purpose.
47 | 8.2 IDB does not warrant that the operation of the Software will be uninterrupted or error free and assumes no obligation to update, correct or improve the Software.
48 | 8.3 The User assumes sole risk for its use, and shall so inform third parties when using, distributing or making the Software available to third parties.
49 |
50 | ### 9. Limitation of Liability
51 | 9.1 IDB shall not be liable, under any circumstances, for damages or compensation, moral or patrimonial; direct or indirect; incidental or special; or by way of consequence, foreseen or unforeseen, which may arise:
52 | 9.1.1 Under any theory of liability, whether in contract, infringement of intellectual property rights, negligence or under any other theory; and/or
53 | 9.1.2 From use of the Software, including but not limited to potential defects in the Software, or loss or inaccuracy of data of any kind. The foregoing includes expenses or damages associated with communication failures and/or computer malfunctions in connection with the use of the Software.
54 |
55 | ### 10. Indemnification
56 | 10.1 The User agrees to release, defend and indemnify the IDB, its staff and consultants, as applicable, from any and all claims, complaints, actions, losses, demands, liabilities, obligations, damages, costs, including without limitation, attorneys' fees, which may be brought against the IDB, its staff and/or consultants by reason of:
57 | 10.1.1 The exercise of the rights granted by IDB under this License.
58 | 10.1.2 User's failure to comply with the terms and conditions of this License.
59 | 10.1.3 Infringement of third party copyrights by the User in connection with the use of the Software and the development of Derivative Software.
60 |
61 | ### Termination of License
62 | IDB may immediately terminate this License, with or without cause, without prior notice to User. Termination for cause applies in the event that IDB determines, in its sole discretion, that use of the Software is inconsistent with the terms and conditions of this License.
63 |
64 | ### Return of Computer System.
65 | In the event of termination of this License, regardless of the cause for termination and at IDB's option, User shall immediately cease use of the Software and shall destroy and/or return to IDB any programs, codes, access, files or information, printed and digital, that are necessary for IDB to have control over the Software, not including any technological protection measures. In the event that User has developed Derivative Software and IDB terminates the License, User must obtain IDB's written authorization to continue using the Software.
66 |
67 | ### 13. Governing Law
68 | This License shall be subject to and construed in accordance with the laws of the District of Columbia, United States of America, except for its conflict of law provisions.
69 |
70 | ### 14. Privileges and Immunities
71 | Nothing in this License shall be construed as a waiver by the IDB or its officers and employees of the privileges and immunities granted to it as a public international organization by its Articles of Incorporation, by international law or by the laws of any of its member countries.
72 |
73 | ### Resolution of Disputes
74 | The Parties undertake to resolve any difference or dispute related to this License in good faith and by means of an amicable settlement. If after thirty (30) calendar days from the date on which a Party notifies the other Party of its disagreement with a difference or dispute, the Parties agree to settle the dispute in good faith and by amicable settlement.
75 | If after thirty (30) calendar days from the date a Party notifies the other Party of its disagreement with a difference or dispute the Parties have not reached an agreement satisfactory to both Parties, such difference or dispute shall be submitted to arbitration in accordance with the rules of the American Arbitration Association. The final determination shall be made by a single arbitrator. The place of arbitration shall be Washington, District of Columbia, United States of America. The language to be used in the arbitration proceedings shall be English with simultaneous translation into any of the official languages of the IDB, if requested by the IDB. The costs of the arbitration shall be borne equally by both Parties.
76 |
77 | ### Relationship between the Parties
78 | Nothing contained in this License shall be construed as establishing or creating a partnership or employer-employee relationship between the Parties, which shall at all times remain independent contractors.
79 |
80 | ### 17. Severability
81 | If any provision of this License is held to be invalid or unenforceable, such invalidity or unenforceability shall not affect the validity and enforceability of the remaining provisions, and such invalid or unenforceable provision shall be deemed severed from this License.
82 |
83 | ### 18. Validity of Obligations
84 | In the event of termination of this License, the rights and obligations set forth in clauses Nos. 3, 7, 8, 9, 10, 13, 14, 15 and 19 shall survive.
85 |
86 | ### Notices
87 | Any notice required under this License shall be made in writing to the IDB at the following e-mail address: code@iadb.org. IDB may amend this clause without notice to User.
88 |
89 | ### 20. Amendment
90 | This License may be amended only with the prior express written consent of the IDB.
91 |
92 | ### Final Agreement
93 | This License constitutes the final agreement between the Parties and supersedes all prior communications, understandings or agreements, written or oral, between the Parties relating to the subject matter of this License.
94 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | ## AM-331-A3 Licencia de Software
2 | Effective: April 2018
3 | Contenido de la página
4 |
5 | El Software, con excepción de los Documentos de Soporte y Uso, deberá estar sujetos a los siguientes términos y condiciones, los cuales se empaquetarán como parte de cada Software bajo un archivo que llevará el nombre de "LICENCIA" :
6 | "Copyright © [2017]. Banco Interamericano de Desarrollo ("BID"). Uso autorizado."
7 |
8 | ### 1. Licencia
9 | Por medio de la presente licencia ("Licencia") no exclusiva, revocable, global y libre de regalías el BID otorga permiso al usuario ("Usuario") para reproducir, distribuir, ejecutar públicamente, prestar y poner a disposición del público, y modificar el software y sus modificaciones, por sí o como parte de una colección, siempre que sea para fines no comerciales, sujeto a los términos y condiciones aquí señalados.
10 | Salvo indicación en contrario, la Documentación de Soporte y Uso del software se licenciará bajo Creative Commons IGO 3.0 Atribución-NoComercial-SinObraDerivada (CC-IGO 3.0 BY-NC-ND).
11 |
12 | #### 2. Definiciones
13 | 2.1 Software: conjunto de programas, instrucciones y reglas informáticas que permiten ejecutar tareas en una computadora a fin de gestionar un determinado proceso u obtener un determinado resultado. El Software incluye (i) código fuente, (ii) código objeto y (iii) Documentación de Soporte y Uso.
14 | El Software puede ser del tipo, pero sin estar limitado a (i) programa ejecutable desde el computador, (ii) aplicación móvil y de escritorio, (iii) algoritmo y (iv) hoja de cálculo que contienen macros, así como otras instrucciones para simular, proyectar o realizar otros cálculos.
15 | 2.2 Código Fuente: conjunto de líneas de texto con los pasos que debe seguir la computadora para ejecutar el Software. Puede estar compuesto por un número indeterminado de documentos, con distintas extensiones y organizados en carpetas.
16 | 2.3 Código Objeto: código que resulta de la compilación del Código Fuente. La compilación es un proceso informático que traduce el Código Fuente en lenguaje máquina o bytecode.
17 | 2.4 Documentación de Soporte y Uso (la "Documentación"): se refiere a la información de acompañamiento al código fuente y objeto que permite a un humano comprender los objetivos, arquitectura y lenguaje de programación de Software.
18 | 2.5 Software Derivado: obras derivadas del Software, tales como modificaciones, actualizaciones y mejoras de la misma.
19 | 2.6 Usuario: cualquier persona, natural o jurídica, que obtenga una copia del Software.
20 |
21 | ### 3. Derechos del BID
22 | 3.1 El BID se reserva todos los derechos de propiedad intelectual, incluyendo sin limitación derechos de autor, relacionados con o asociados al Software.
23 | 3.2 El BID se reserva expresamente los derechos de ceder, transferir y/o sub-licenciar el Software y/o cualquiera de sus componentes a terceros sin previo aviso.
24 |
25 | ### 4. Derechos del Usuario sobre Software Derivado
26 | El Usuario que desarrolle Software Derivado retendrá todos los derechos de propiedad intelectual, incluyendo sin limitación derechos de autor, relacionados con o asociados al Software Derivado, en el entendido que dicho Software Derivado y cualquier otra edición futura estén sujetas a los mismos términos y condiciones de esta Licencia.
27 |
28 | ### 5. Restricciones
29 | 5.1 El Usuario sólo está autorizado a hacer uso del Software conforme se describe en esta Licencia.
30 | 5.2 Con excepción de esta Licencia, el BID no otorga ninguna otra licencia al Usuario con respecto a cualquier otra información u obra propiedad del BID o de cualquier derecho de autor, marcas o cualquier otro derecho de propiedad intelectual del BID. Cualquier licencia adicional deberá ser por escrito y firmada por un representante del BID debidamente autorizado para tales fines.
31 | 5.3 La Licencia no constituye una venta del Software ni de cualquier parte o copia de la misma.
32 | 5.4 El Usuario no podrá usar ni permitir que otros usen el Software para fines comerciales.
33 | 5.5 El Usuario sólo podrá autorizar el uso del Software a terceros de conformidad con lo establecido en esta Licencia, sin que en ningún caso los terceros puedan adquirir más derechos sobre el Software que los expresamente otorgados por el BID mediante esta Licencia.
34 |
35 | ### 6. Reconocimiento
36 | 6.1 El Usuario deberá mantener los siguientes enunciados y exenciones en el archivo principal de la Documentación del Software:
37 | "Copyright © [año]. Banco Interamericano de Desarrollo ("BID"). Uso autorizado.
38 | Los procedimientos y resultados obtenidos en base a la ejecución de este software son los programados por los desarrolladores y no necesariamente reflejan el punto de vista del BID, de su Directorio Ejecutivo ni de los países que representa."
39 | 6.1.1 En el caso de Software del Fondo Multilateral de Inversiones ("FOMIN"), la exención de responsabilidad deberá ser: "Las opiniones expresadas en esta obra son de los autores y no necesariamente reflejan el punto de vista del BID, de su Directorio Ejecutivo ni de los países que representa, así como tampoco del Comité de Donantes del FOMIN ni de los países que representa."
40 | 6.2 El Usuario podrá incluir en el Software Derivado una referencia al Software como obra original, siempre y cuando dicho aviso no genere confusión alguna respecto a la titularidad de los derechos del BID sobre el Software.
41 |
42 | ### 7. Nombre y Logo del BID
43 | El Usuario no podrá hacer uso del nombre y/o logo del BID para fines diferentes a los aquí estipulados, ni podrá hacer promesas, ni adquirir compromisos u obligaciones, ni otorgar garantías de ninguna clase en nombre del BID.
44 |
45 | ### 8. Declaraciones y Garantías
46 | 8.1 El BID otorga esta Licencia sin garantía explícita o implícita de ningún género, objetiva o subjetiva, por responsabilidad contractual o extracontractual, lo que comprende, sin consistir en una enumeración taxativa, garantías de comerciabilidad, adecuación, cumplimiento de normas o requisitos o aplicabilidad para un fin determinado.
47 | 8.2 El BID no garantiza que el funcionamiento del Software será ininterrumpido o libre de errores y no asume obligación alguna de actualizar, corregir ni introducir mejoras en el Software.
48 | 8.3 El Usuario asume exclusivamente el riesgo por su utilización, y así deberá informarlo a terceros cuando utilice, distribuya o ponga el Software a disposición de terceros.
49 |
50 | ### 9. Limitación de Responsabilidad
51 | 9.1 El BID no será responsable, bajo circunstancia alguna, de daño ni indemnización, moral o patrimonial; directo o indirecto; accesorio o especial; o por vía de consecuencia, previsto o imprevisto, que pudiese surgir:
52 | 9.1.1 Bajo cualquier teoría de responsabilidad, ya sea por contrato, infracción de derechos de propiedad intelectual, negligencia o bajo cualquier otra teoría; y/o
53 | 9.1.2 A raíz del uso del Software, incluyendo, pero sin limitación de potenciales defectos en el Software, o la pérdida o inexactitud de los datos de cualquier tipo. Lo anterior incluye los gastos o daños asociados a fallas de comunicación y/o fallas de funcionamiento de computadoras, vinculados con la utilización del Software.
54 |
55 | ### 10. Indemnización
56 | 10.1 El Usuario se obliga a liberar, defender e indemnizar al BID, su personal y consultores, conforme sea aplicable, de cualquier reclamo, queja, acción, pérdida, demanda, responsabilidad, obligación, daño, costo, incluyendo sin limitación, honorarios de abogados, que pudiesen emprender contra el BID, su personal y/o consultores en virtud de:
57 | 10.1.1 El ejercicio de los derechos otorgados por el BID bajo esta Licencia.
58 | 10.1.2 Incumplimiento de los términos y condiciones de esta Licencia por parte del Usuario.
59 | 10.1.3 Infracción de derechos de autor de terceros por parte del Usuario con relación al uso del Software y el desarrollo de Software Derivado.
60 |
61 | ### 11. Terminación de la Licencia
62 | El BID podrá terminar de manera inmediata esta Licencia, con causa o sin causa, sin dar aviso previo al Usuario. La terminación con causa aplica en caso de que el BID determine, a su entera discreción, que el uso del Software es inconsistente con los términos y condiciones de esta Licencia.
63 |
64 | ### 12. Devolución del Sistema Informático
65 | En caso de terminación de esta Licencia, indistintamente de la causa de terminación y conforme decida el BID, el Usuario deberá inmediatamente cesar el uso del Software y deberá destruir y/o devolver al BID cualesquiera programas, códigos, accesos, archivos o información, impresa y digital, que sean necesarios para que el BID tenga control sobre el Software, sin incluir medida de protección tecnológica alguna. En caso de que el Usuario haya desarrollado Software Derivado y el BID termine la Licencia, el Usuario deberá obtener autorización del BID, por escrito, para poder seguir usando el Software.
66 |
67 | ### 13. Ley Aplicable
68 | Esta Licencia estará sujeta a y será interpretada de conformidad con las leyes del Distrito de Columbia de los Estados Unidos de América, con excepción de sus disposiciones respecto a conflicto de leyes.
69 |
70 | ### 14. Privilegios e Inmunidades
71 | Ninguna cláusula de esta Licencia podrá ser interpretada como un acto de renuncia por parte del BID o de sus funcionarios y empleados a los privilegios e inmunidades que le han sido concedidos como organización internacional pública por su Convenio Constitutivo, por el derecho internacional o por las leyes de cualquiera de sus países miembros.
72 |
73 | ### 15. Resolución de Disputas
74 | Las Partes se comprometen a resolver cualquier diferencia o disputa relacionada con esta Licencia de buena fe y mediante un arreglo amigable. Si al cabo de treinta (30) días calendario de la fecha en que una Parte le comunique a la otra Parte su disconformidad con una diferencia o disputa las Partes no han llegado a un acuerdo satisfactorio para ambas Partes, dicha diferencia o disputa será sometida a arbitraje de conformidad con las reglas de la American Arbitration Association. La determinación final le corresponderá a un único árbitro. El lugar del arbitraje será Washington, Distrito de Columbia, Estados Unidos de América. El idioma que se usará en el proceso de arbitraje será el inglés con traducción simultánea en cualquiera de los idiomas oficiales del BID, si el BID lo solicitara. Los gastos del arbitraje serán cubiertos por ambas Partes en igual proporción.
75 |
76 | ### 16. Relación entre las Partes
77 | Nada de lo contenido en esta Licencia se interpretará como el establecimiento o creación de una asociación ni relación empleador-empleado entre las Partes, las cuales en todo momento permanecerán como contratistas independientes.
78 |
79 | ### 17. Divisibilidad
80 | Si cualquier cláusula de esta Licencia es considerada inválida o inexigible, dicha invalidez o inexigibilidad no afectará a la validez ni la exigibilidad de las demás cláusulas, y dicha cláusula inválida o inexigible se considerará eliminada de esta Licencia.
81 |
82 | ### 18. Validez de Obligaciones
83 | En caso de terminación de esta Licencia sobrevivirán los derechos y las obligaciones previstas en las cláusulas Nos. 3, 7, 8, 9, 10, 13, 14, 15 y 19.
84 |
85 | ### 19. Notificaciones
86 | Cualquier notificación que se requiera en el marco de esta Licencia se hará por escrito al BID a la siguiente cuenta de correo electrónico: code@iadb.org. El BID podrá modificar esta cláusula sin dar previo aviso al Usuario.
87 |
88 | ### 20. Enmienda
89 | Esta Licencia sólo podrá ser modificada mediante autorización previa, expresa y por escrita del BID.
90 |
91 | ### 21. Acuerdo Final
92 | Esta Licencia constituye el acuerdo final entre las Partes y reemplaza todas las comunicaciones, entendimientos o acuerdos, escritos o verbales, de carácter previo entre las Partes con relación al objeto de esta Licencia.
93 |
--------------------------------------------------------------------------------