From 71e97f541c6842a9a548bb0497b3adf63ab435ea Mon Sep 17 00:00:00 2001 From: Shayane Alcantara Date: Sat, 31 Aug 2019 19:45:30 -0300 Subject: [PATCH 1/5] Add translated templates to issues, pr and reports --- .../ISSUE_TEMPLATE/issue_template_meeting.md | 43 +++++++++---------- .github/ISSUE_TEMPLATE/issue_template_us.md | 15 +++---- .github/PULL_REQUEST_TEMPLATE.md | 19 ++++---- 3 files changed, 36 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue_template_meeting.md b/.github/ISSUE_TEMPLATE/issue_template_meeting.md index 79ee883..e31d625 100644 --- a/.github/ISSUE_TEMPLATE/issue_template_meeting.md +++ b/.github/ISSUE_TEMPLATE/issue_template_meeting.md @@ -1,43 +1,43 @@ --- -name: Issue template Ata -about: Pattern template for the creation of the issues meetings +name: Template de Ata +about: Template padrão para criação de atas de reunião --- - + - + - + - + - + - + - + - - - - + + + + - + @@ -66,12 +66,6 @@ about: Pattern template for the creation of the issues meetings - - - - - - @@ -98,11 +92,14 @@ about: Pattern template for the creation of the issues meetings - + + + + - + -
Meeting X
Reunião X
DateData
Managed byPresidida por
Kind of meetingTipo de Reunião
DiscussionDiscussão
ConclusionConclusão
Members
Integrantes
Name
Subject
Presence
Justification
Nome
Disciplina
Presença
Justificativa
Fabíola Malta Fleury
EPS
MDS
Guilherme Marques
MDS
Hugo Sobral de Lima Salomão
Beginning
Duração
Início
FinishTérmino
\ No newline at end of file + diff --git a/.github/ISSUE_TEMPLATE/issue_template_us.md b/.github/ISSUE_TEMPLATE/issue_template_us.md index 0eedf6a..2d18718 100644 --- a/.github/ISSUE_TEMPLATE/issue_template_us.md +++ b/.github/ISSUE_TEMPLATE/issue_template_us.md @@ -1,18 +1,17 @@ --- -name: US issue -about: Pattern template for the creation of the User Stories issues +name: Template de issue +about: Template padrão para criação das issues --- -## Issue title (if it is a User Story, US X - Issue name) +## Título da issue -### Description: +### Descrição: -### Acceptance standards: +### Critérios de aceitação: - -### Tasks: - -- [ ] +### Tarefas: +- [ ] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1a5b71c..1c4d0be 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,17 @@ -## Description +## Descrição -Complete description about what was done. +Descrição completa do que foi feito -## Related PRs +## PRs relacionados -Branch | PR +branch | PR ------ | ------ -other_pr_production | [link]() -other_pr_master | [link]() +outro_pr_relacionado | [link]() -## Solves (Issues) +## Resolve (Issues) -Issues that have been solved with the PR +Issues que foram resolvidas com o PR -## PR Extra observations +## Notas pessoais sobre o PR -Specific observations about the PR \ No newline at end of file +Ressalvas específicas sobre o PR \ No newline at end of file From afc951fef7590dd1b6cad8a45d6dbce85a59b9e1 Mon Sep 17 00:00:00 2001 From: Shayane Alcantara Date: Sat, 31 Aug 2019 20:11:35 -0300 Subject: [PATCH 2/5] Adjust meeting report template --- .github/ISSUE_TEMPLATE/issue_template_meeting.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue_template_meeting.md b/.github/ISSUE_TEMPLATE/issue_template_meeting.md index e31d625..bcff408 100644 --- a/.github/ISSUE_TEMPLATE/issue_template_meeting.md +++ b/.github/ISSUE_TEMPLATE/issue_template_meeting.md @@ -91,9 +91,6 @@ about: Template padrão para criação de atas de reunião
- -
Duração - Início From 7efaaa948df493e5d06ef95ec314d278e6f1d9cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADtor=20Xoteslem?= Date: Tue, 3 Sep 2019 23:38:41 -0300 Subject: [PATCH 3/5] Translate policies document and fix sidebar --- docs/_sidebar.md | 2 +- docs/policies.md | 127 +++++++++++++++++++++++++---------------------- 2 files changed, 68 insertions(+), 61 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index f928349..a2a739a 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -2,4 +2,4 @@ * [Home](/) * [Policies](policies.md) -* [Termo de Abertura(project_charter.md) +* [Termo de Abertura](project_charter.md) diff --git a/docs/policies.md b/docs/policies.md index b6e7396..6e12496 100644 --- a/docs/policies.md +++ b/docs/policies.md @@ -1,131 +1,138 @@ -# Repository Policies +# Políticas do Repositório -## Introduction +## Introdução -This document is intended to explain the procedures to be performed in order to correctly follow this repository policies. +Este documento tem como objetivo explicar os procedimentos a serem feitos para que as políticas deste repositório sejam seguidas adequadamente. -Here you can find our: +Aqui se encontram: -- Branch policies -- Commit policies +- Política de Branch +- Política de Commits -## Branch Policies +## Políticas de Branch -Branches must follow the rules explained in this section and must be written in English. +Branches devem seguir as seguintes regras explicadas neste tópico: -Brief work flow explanation: +Breve explicação sobre o fluxo de trabalho: -- The **master** branch represents the stable version of the product, containing tested and versioned code, which is ready to be delivered to the final user or customer. This branch comes from the **develop** branch through pull requests approved at the end of each release. +- A branch **master** representa uma versão estável do produto, contendo código já testado e versionado, pronto para ser entregue ao usuário final ou cliente. Essa branch parte da branch **develop** através de pull requests aprovados no fim de cada release. - Rules: + Regras: - 1. There is only one **master** branch. + 1. Existe apenas uma branch **master**. + 2. **Não** são permitidos commits feitos diretamente na **master**. - 2. Commits made **directly** in this branch are **not** allowed. - +- A branch **develop** contém a versão mais atualizada do código que está sendo desenvolvido. Essa branch está sempre sincronizada com a **master** e é base para as branches **feature**. -- The **develop** branch contains the most updated version of the code we are working on. This branch is always synchronized with the **master** branch and is the base of all **feature** branches. + Regras: - Rules: + 1. Existe apenas uma branch **develop**. + 2. Essa branch está sempre sincronizada com a branch **master**. - 1. This branch is always synchronized with the **master** branch. - +- As branches **feature** representam as funcionalidades do sistema a serem desenvolvidas, elas devem ter a branch **develop** como sua origem e fim. -- The **feature** branches represent the system features to be developed, they must have the **develop** branch as both start and end. + Regras: - Rules: + 1. Essa branch sempre é criada a partir da branch **develop**. + 2. Essa branch sempre é mesclada à branch **develop**. + + Regras de nomenclatura: - 1. This branch always come from the **develop** branch. - 2. This branch is always merged to the **develop** branch. + `feature/issueID-titulo-da-issue` - Naming rules: - `feature/issueID-issue-name` +- A branch **release** representa o conjunto de funcionalidades provenientes de um ponto específico da branch **develop**. Essa branch contém funcionalidades prontas que, provavelmente, estarão presentes na próxima versão estável do produto. Apenas **bug fixes** são permitidos nessa branch. - + Regras: -- The **release** branch represents a set of features coming from a specific point of the **develop** branch. This branch contains features that will probably be in the next stable release of the product. Only **bug fixes** are allowed in this branch. + 1. Essa branch sempre é criada a partir da branch **develop**. + 2. Essa branch sempre é mesclada às branches **develop** e **master**. + 3. Essa branch aceita apenas mesclagens de branches do tipo **bugfix**. - Rules: + Regras de nomenclatura: - 1. This branch always come from the **develop** branch. - 2. This branch is always merged to the **develop** and **master** branches. - 3. This branch only accepts merges from **bugfix** branches. + `release/vNúmero-da-versão` + + - Naming rules: - `release/vVersion-number` +- As branches do tipo **bugfix** são utilizadas para implementar soluções para bugs, encontrados através de testes realizados em releases específicas, na branch **release**. Isso significa que a branch **bugfix** deve ter a branch **release** como sua origem e fim. - + Regras: -- The **bugfix** branches are used to implement solutions to bugs, found through tests applied to specific releases, in the **release** branch. This means that this branch must be started from and merged into a **release** branch. + 1. Essa branch sempre é criada a partir da branch **release**. + 2. Essa branch sempre é mesclada na branch **release**. - Rules: + Regras de nomenclatura: - 1. This branch always come from the **release** branch. - 2. This branch is always merged to the **release** branch. + `bugfix/issueID-titulo-da-issue` + + + + A branch **hotfix** é utilizada para implementar soluções para problemas urgentes encontrados no ambiente de produção. Isso significa que essa branch deve ter a branch **master** como sua orgigem e fim. - Naming rules: - `bugfix/issueID-issue-name` +- Regras: + 1. Essa branch sempre é criada a partir da branch **master**. +2. Essa branch sempre é mesclada à branch **master**. + Regras de nomenclatura: -- The **hotfix** branch is used to implement solutions to urgent bugs found in the live environment. This means that this branch must be started and merged into the **master** branch. + `hotfix/issueID-titulo-da-issue` - Rules: - - 1. This branch always come from the **master** branch. -2. This branch is always merged to the **master** branch. + - Naming rules: - `hotfix/issueID-issue-name` +Observações: O título da issue utilizado no nome das branches deve ser mantido em português. - - Here are some images representing this work flow: + Imagens para ajudar a visualizar o fluxo de trabalho descrito: ![](https://fpy.cz/pub/slides/git-workshop/images/gitflow.png) ![](https://miro.medium.com/max/640/0*FTwKYpFGADX-5Y0O) - ## Commit Policies -Commits should be briefly and clearly written, in English, describing what was done. +## Políticas de Commits +Commits devem ser escritos de forma clara e breve, em Inglês, descrevendo as alterações feitas. -Commit writing rules: +Regras para escrita das mensagens nos commits: ``` -#issueID Concise Message up to 50 characters +#issueID Mensagem breve descrevendo alterações -Optional and more detailed message +Mensagem mais detalhada sobre o que foi feito neste commit. (Opcional) ``` -You can automatically close an issue by adding the keyword "Fix" before the #issueID: +É possível fechar uma issue automaticamente adicionando a palavra chave "Fix" antes do id da issue: `Fix #issueID Concise Message` -The commit concise message must uses the imperative, present tense. Here are some examples: +O caractere "#", por padrão, representa uma linha de comentário no arquivo de mensagem do commit. Para evitar problemas, é necessário alterar o caractere com o seguinte comando: + +`git config --local core.commentChar auto` -Bad examples: +Caso deseje utilizar um outro caractere específico para definir uma linha de comentário, basta substituir a palavra "auto" pelo caractere desejado. + +A mensagem principal do commit deve ser escrita no modo imperativo. Aqui estão alguns exemplos: + +Maus exemplos: `Renamed the iVars and removed the common prefix.` `Creating branch policies document ` -Good examples: +Bons exemplos: `Rename the iVars to remove the common prefix. ` `Create branch policies document` - -## References +## Referências [Git-flow Applied to a Real Project](https://medium.com/empathyco/git-flow-applied-to-a-real-project-c08037e28f88) [Writing git commit message](https://365git.tumblr.com/post/3308646748/writing-git-commit-messages) - From 4baa98618a53bf868bdacc1a25d8acca05966b89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADtor=20Xoteslem?= Date: Wed, 4 Sep 2019 19:13:44 -0300 Subject: [PATCH 4/5] Add versions history and translate sidebar --- docs/_sidebar.md | 2 +- docs/policies.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index a2a739a..0d3a4a8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,5 +1,5 @@ * [Home](/) -* [Policies](policies.md) +* [Políticas do Repositório](policies.md) * [Termo de Abertura](project_charter.md) diff --git a/docs/policies.md b/docs/policies.md index 6e12496..0715aee 100644 --- a/docs/policies.md +++ b/docs/policies.md @@ -1,4 +1,10 @@ # Políticas do Repositório +## Histórico de versão + +| Data | Versão | Modificação | Autor | +| :- | :- | :- | :- | +| 23/08/2019 | 1.0 | Criação da primeira versão do documento | Vítor Cardoso | +| 03/09/2019 | 1.1 | Tradução do documento para português | Vítor Cardoso | ## Introdução From 64c92db8705ca93cf43a24a6d59079946d7fb756 Mon Sep 17 00:00:00 2001 From: Shayane Alcantara Date: Wed, 4 Sep 2019 19:32:50 -0300 Subject: [PATCH 5/5] Adding new templates and adjusting others --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++ .github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md | 26 ++++++++++++++ .github/ISSUE_TEMPLATE/issue_template_us.md | 9 +++-- .github/PULL_REQUEST_TEMPLATE.md | 18 +++++----- 4 files changed, 76 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1dc0dfe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Reporte um bug para nos ajudar a melhorar + +--- + +**Descreva o bug** +Uma descrição clara e concisa do que é o bug. + +**Para reproduzir** +Passos para reproduzir o comportamento: +1. Vá para '...' +2. Clique em '....' +3. Desça a tela até '....' +4. Veja o erro + +**Comportamento esperado** +Uma descrição clara e concisa do que era esperado acontecer. + +**Screenshots ou capturas de tela** +Se aplicável, adicione screenshots para ajudar a explicar seu problema. + +**Desktop (por favor, informe qual é o navegador, browser utilizado ao encontrar o bug):** + - OS: [ex.: iOS] + - Browser [ex.: chrome, safari] + - Version [ex.: 22] + +**Smartphone (por favor, informe qual é o navegador, browser utilizado ao encontrar o bug):** + - Device: [ex.: iPhone6] + - OS: [ex.: iOS8.1] + - Browser [ex.: stock browser, safari] + - Version [ex.: 22] + +**Informações adicionais** +Adicione outras informações sobre o problema aqui, se necessário. diff --git a/.github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md b/.github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md new file mode 100644 index 0000000..b6231c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md @@ -0,0 +1,26 @@ +--- +name: História de Usuário +about: Descrição de uma história de usuário + +--- + +**Descrição** +Eu, como ***persona***, gostaria de ***realizar algo*** para ***alcance um objetivo***. + +**Critérios de Aceitação** [?](http://www.metodoagil.com/historias-de-usuario/) +- Deverá ter o campo ...; +- Deverá calcular/apresentar ...; +- Funcionalidade testada; + + +**Tarefas** +- [ ] Não é um épico. [Leia](https://sitecampus.com.br/user-story-epico-e-tema-qual-diferenca/); +- [ ] É testável; +- [ ] É estimável pelo time de desenvolvimento; +- [ ] Traz valor ao negócio; + +**Observações** + +- A issue deve ser pontuada; +- A issue deve ser delegada a alguém; +- A issue deve ter labels; diff --git a/.github/ISSUE_TEMPLATE/issue_template_us.md b/.github/ISSUE_TEMPLATE/issue_template_us.md index 2d18718..3648397 100644 --- a/.github/ISSUE_TEMPLATE/issue_template_us.md +++ b/.github/ISSUE_TEMPLATE/issue_template_us.md @@ -1,17 +1,20 @@ --- -name: Template de issue -about: Template padrão para criação das issues +name: Template de issue comum +about: Template padrão para criação das issues comuns --- -## Título da issue +## Título da issue ### Descrição: +Descrever issue brevemente, inserindo informações necessárias para o entendimento. ### Critérios de aceitação: +Descrever o que a issue precisa cumprir para ser considerada finalizada. - ### Tarefas: +Checklist de ações que devem ser realizadas. - [ ] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1c4d0be..355f8be 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,17 @@ ## Descrição -Descrição completa do que foi feito - -## PRs relacionados - -branch | PR ------- | ------ -outro_pr_relacionado | [link]() +Descrição concisa do que foi feito ## Resolve (Issues) Issues que foram resolvidas com o PR -## Notas pessoais sobre o PR +## PRs relacionados, se houver + +branch | PR +------ | ------ +outro_pr_relacionado | [link]() -Ressalvas específicas sobre o PR \ No newline at end of file +## Tarefas gerais realizadas +* Tarefa 1 +* Tarefa 2 \ No newline at end of file