-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #74 from fga-eps-mds/contribuicao
[docs:73] - add contributing guide
- Loading branch information
Showing
6 changed files
with
107 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,20 @@ | ||
| # Quadro de disponibilidade | ||
|
|
||
| Para facilitar o agendamento de reuniões do time foi criada uma planilha de disponibilidade. Cada um preencheu a planilha com horários em que os integrantes estavam livres e os horários disponíveis com agendamento prévio, porém com a quantidade de pessoas na equipe foi difícil encontrar horários em que todos estivessem livres. Dessa forma, foi definido um quórum mínimo de reunião de 8 pessoas (garantindo um mínimo de metade dos MDS presentes). | ||
| Para facilitar o agendamento de reuniões do time foi criada uma [planilha de disponibilidade](https://docs.google.com/spreadsheets/d/1hlGeAVgnl61sQaBjaKO4eLPD89xi4YocaeJpEu7D8Yo/edit?usp=drive_link). Cada um preencheu a planilha com horários em que os integrantes estavam livres e os horários disponíveis com agendamento prévio, porém com a quantidade de pessoas na equipe foi difícil encontrar horários em que todos estivessem livres. Dessa forma, foi definido um quórum mínimo de reunião de 8 pessoas (garantindo um mínimo de metade dos MDS presentes). | ||
|
|
||
| <iframe width=750 height=500 src="https://docs.google.com/spreadsheets/d/1hlGeAVgnl61sQaBjaKO4eLPD89xi4YocaeJpEu7D8Yo/edit?usp=sharing"></iframe> | ||
|
|
||
| ## Horários de reuniões | ||
| ## Horários de reuniões | ||
|
|
||
| | Reunião | Horário | Modelo | | ||
| | - | - | - | | ||
| | Reunião com cliente | Toda segunda às 20h | Remoto | | ||
| | Dojo | Esporadicamente conforme agendamento | Remoto/Presencial | | ||
| | Reunião | Horário | Modelo | | ||
| | ------------------- | ------------------------------------ | ----------------- | | ||
| | Reunião com cliente | Toda segunda às 20h | Remoto | | ||
| | Dojo | Esporadicamente conforme agendamento | Remoto/Presencial | | ||
|
|
||
| ## Histórico de versão | ||
|
|
||
| | Alteração | Data | Autor | | ||
| | - | - | - | | ||
| | Alteração | Data | Autor | | ||
| | -------------------- | -------- | ----------- | | ||
| | Criação do documento | 27/03/24 | Sara Campos | | ||
| | Correções | 28/03/24 | Sara Campos | | ||
| | Correções | 28/03/24 | Sara Campos | | ||
| | Atualização | 03/08/24 | Sara Campos | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| # Quadro de conhecimento | ||
|
|
||
| Para entender de onde cada integrante está partindo em termos de conhecimento sobre as tecnologias usadas e monitorar a evolução de cada um ao longo da disciplina foi criado um quadro de conhecimento. A equipe preencheu o quadro conforme uma autoavaliação do seu nível de conhecimento técnico. Esse quadro ajuda a avaliar demanda de dojos para os MDS, assim como ajuda a formar bons pareamentos conforme as habilidades de cada pessoa do time. | ||
| Para entender de onde cada integrante está partindo em termos de conhecimento sobre as tecnologias usadas e monitorar a evolução de cada um ao longo da disciplina foi criado um [quadro de conhecimento](https://docs.google.com/spreadsheets/d/1HQ_o1laqoAk8lofKAW6C_xOTveCuSv-IzFBjpnb1OsA/edit?usp=drive_link). A equipe preencheu o quadro conforme uma autoavaliação do seu nível de conhecimento técnico. Esse quadro ajuda a avaliar demanda de dojos para os MDS, assim como ajuda a formar bons pareamentos conforme as habilidades de cada pessoa do time. | ||
|
|
||
| <iframe width=750 height=500 src="https://docs.google.com/spreadsheets/d/1HQ_o1laqoAk8lofKAW6C_xOTveCuSv-IzFBjpnb1OsA/edit?usp=sharing | ||
| "></iframe> | ||
|
|
||
| ## Histórico de versão | ||
|
|
||
| | Alteração | Data | Autor | | ||
| | - | - | - | | ||
| | Criação do documento | 27/03/24 | Sara Campos | | ||
| | Alteração | Data | Autor | | ||
| | -------------------- | -------- | ----------- | | ||
| | Criação do documento | 27/03/24 | Sara Campos | | ||
| | Atualização | 03/08/24 | Sara Campos | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,30 +22,53 @@ As issues do projetos devem ser completas e explicativas, seguindo o template de | |
| As issues devem conter: | ||
|
|
||
| - Um título conciso e descritivo; | ||
| - Uma descrição, seguindo o template do repositório, que deve incluir uma descrição completa da issue e criterios para a aceitação; | ||
| - Um *Assignee* responsável pela issue; | ||
| - *Labels* signaficativas; | ||
| - *Milestone* (sprint) em que a issue deve ser concluiída; | ||
| - *Estimated* (pontuação) atribuida a issue; | ||
| - Uma descrição que deve incluir uma descrição completa da issue e suas tarefas; | ||
| - Em caso de História de Usuário, descrever de maneira clara e detalhadas os criterios de aceitação, assim como adicionar o prótitpo navegável do fluxo em questão; | ||
| - Ao menos um _Assignee_ responsável pela issue; | ||
| - [_Labels_](#labels); | ||
| - _Milestone_ (sprint) em que a issue espera ser concluiída; | ||
| - _Estimated_ (pontuação) atribuida a issue; | ||
|
|
||
| ### Labels | ||
|
|
||
| Na criação de uma issue, devem ser usados os rótulos abaixo para classifcá-la: | ||
|
|
||
| - Bug: indica um problema ou comportamento inesperados | ||
| - UX: indica que a issue é referente a práticas de _User Experience_ | ||
| - Treinamento: indica que a issue é sobre treinamentos (dojos) | ||
| - Hotfix (cor #d73a4a): indica uma correção de defeitos críticos | ||
| - Docs (cor #0075ca): indica a aplicação de melhorias ou adições à documentação do projeto | ||
| - Feature (cor #094EF2): indica a introdução de uma funcionalidade nova US (cor #BE71F6): indica que a issue é uma história de usuário (user story) | ||
| - Frontend (cor #56384A): Indica que está relacionada ao frontend da aplicação | ||
| - Backend (cor #95BDC7): Indica que está relacionada ao backend da aplicação | ||
| - Arq (cor #0D5571): indica mudanças na arquitetura da aplicação ou de um de seus módulos ou serviços | ||
| - Devops (cor #9014A0): indica mudanças na esteira de integração e disponibilização contínua | ||
| - Analytics (cor #12477F): indica mudanças nos analisadores estáticos | ||
| - Easy (cor #C5DEF5): indica que a issue tem uma dificuldade baixa | ||
| - Medium (cor #BFD4F2): indica que a issue possui um grau médio de dificuldade | ||
| - Hard (cor #D4C5F9): indica que a issue possui um alto grau de dificuldade | ||
| - EPS #006633: indica que a issue será trabalhado por alunos da disciplina de Engenharia de Produto de Software (EPS) | ||
| - MDS (cor #0068b4): indica que a issue será trabalhado por alunos da disciplina de Métodos de Desenvolvimento de Software (MDS) | ||
|
|
||
| ## Politica de branches | ||
|
|
||
| ### Repositórios de desenvolvimento | ||
|
|
||
| Nos repositórios a **main** é a branch principal. | ||
| Nos repositórios a **devel** é a branch padrão que está sempre atualizada. A branch **main** comporta as Releases lançadas do projeto, sendo a branch mais estável. | ||
|
|
||
| #### main | ||
|
|
||
| A branch **main** deve ser a branch mais estável do projeto, que estará em produção. Essa branch é protegida de commits e para o desenvolvimento de novas funcionalidades, deve receber Pull Requests (PRs). | ||
|
|
||
| #### development | ||
| A branch **development** deve ser a branch de desenvolvomento do projeto, que estará em produção. Essa branch também é protegida de commits e para o desenvolvimento de novas funcionalidades, deve receber Pull Requests assim como a **main**(PRs). Uma vez que todas as funcionalidades da sprint são testadas e mescladas na branch de desenvolvimento podemos mesclar com a branch principal, a **main**. | ||
|
|
||
| A branch **devel** deve ser a branch de desenvolvomento do projeto, que estará em produção. Essa branch também é protegida de commits e para o desenvolvimento de novas funcionalidades, deve receber Pull Requests assim como a **main**(PRs). Uma vez que todas as funcionalidades da sprint são testadas e mescladas na branch de desenvolvimento podemos mesclar com a branch principal, a **main**. | ||
|
|
||
| #### Novas branches | ||
| As branches para o desenvolvimento de novas features devem ser criadas a partir da branch **main** e devem seguir o padrão **x-nome-da-issue**, onde x é o número da issue que será resolvida na branch, acompanhado pelo nome da issue. | ||
|
|
||
| Os Pull Requests das novas branches devem ser feitos para a branch **main**. | ||
| As branches para o desenvolvimento de novas features devem ser criadas a partir da branch **devel** e devem seguir o padrão **x-nome-da-issue**, onde x é o número da issue que será resolvida na branch, acompanhado pelo nome da issue. | ||
|
|
||
| Em casos de correções rápidas de bugs, a branch deve seguir o padrão **FIX-x-problema-a-ser-resolvido**, onde x é o número da issue, caso tenha. | ||
| Os Pull Requests das novas branches devem ser feitos para a branch **devel**. | ||
|
|
||
| ### Repositório de documentação | ||
|
|
||
|
|
@@ -75,11 +98,13 @@ Co-authored-by: Nome da dupla <[email protected]>" | |
| git commit -sm "[fix:7] - Add contributing guide | ||
| Co-authored-by: Nome da dupla <[email protected]>" | ||
| git commit -sm "[docs:7] - Add contributing guide | ||
| ``` | ||
|
|
||
| ## Politica de pull requests | ||
|
|
||
| Os PRs devem ser feitos a branch **main**. | ||
| Os PRs devem ser feitos a branch **devel**. | ||
|
|
||
| Os Pull Requests devem ser feitos seguindo o template: | ||
|
|
||
|
|
@@ -99,11 +124,19 @@ Em casos de PRs em que ainda estão sendo desenvolvidos, deve ser acrescentado a | |
|
|
||
| Os PRs devem conter: | ||
|
|
||
| - Um título conciso e descritivo; | ||
| - Um *Assignee* responsável pelo PR; | ||
| - Um *Reviewer* responsável pela revisão do PR; | ||
| - *Labels* signaficativas; | ||
| - Uma issue associada; | ||
| - Uma descrição, seguindo o template do repositório, que deve incluir uma descrição completa do que foi feito e a issue relacionada. | ||
| - Um título conciso e descritivo; | ||
| - Um _Assignee_ responsável pelo PR; | ||
| - Um _Reviewer_ responsável pela revisão do PR; | ||
| - _Labels_ significativas; | ||
| - Uma issue associada; | ||
| - Uma descrição, seguindo o template do repositório, que deve incluir uma descrição completa do que foi feito e a issue relacionada. | ||
|
|
||
| Os PRs só serão aceitos após passarem pelo CI estabelecido e por duas revisões. | ||
|
|
||
| ## Histórico de versão | ||
|
|
||
| Os PRs só serão aceitos após passarem pelo CI estabelecido e por duas revisões. | ||
| | Alteração | Data | Autor | | ||
| | --------------------------- | -------- | ------------ | | ||
| | Criação do documento | | Victor Yukio | | ||
| | Atualização | | Ingrid | | ||
| | Revisão e adição das labels | 03/08/24 | Sara Campos | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,27 @@ | ||
| # Identidade Visual | ||
|
|
||
| Na reunião com o cliente do dia 1º de abril foi apresentada e aprovada a nova identidade visual (IDV) do produto. | ||
| Na reunião com o cliente do dia 1º de abril foi apresentada e aprovada a nova [identidade visual (IDV)](https://www.figma.com/design/rgl6c0lXvhJ0vI6pmL352q/Proposta-de-IDV?node-id=0-1&t=FHcqBkMwYtENzN60-1) do produto. | ||
|
|
||
| A nova IDV conta com uma paleta de cores selecionada trazendo identificação para o SINDPOL, além passar mensagens de comprometimento, organização e elegância para o usuário. Foi realizado teste de contraste com a paleta de cores para validar a leiturabilidade para pessoas com daltonismo e outras deficiências que impactem a percepção das cores. Além disso, com a paleta de cores foram geradas 55 variáveis de cores para serem usadas no protótipo mantendo a identidade visual. | ||
|
|
||
| Com relação a tipografia, foram escolhidas duas fontes sem-serifa que passam modernidade e seriedade para o usuário ao interagir com o produto. As fontes contém também grande cobertura de caracteres e alta variabilidade de estilos, pesos e comprimentos. Os ícones que devem ser usados no produto, seguindo a mesma ideia da tipografia, serão do pacote Ant Design Icons da biblioteca React Icons. | ||
|
|
||
|
|
||
| ### Proposta de Identidade Visual apresentada e aprovada | ||
|
|
||
| <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="800" height="450" src="https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Fproto%2Frgl6c0lXvhJ0vI6pmL352q%2FProposta-de-IDV%3Fpage-id%3D0%253A1%26type%3Ddesign%26node-id%3D6-2288%26viewport%3D461%252C927%252C0.48%26t%3DFYT2mvh3mVrTcSJp-1%26scaling%3Dcontain%26mode%3Ddesign" allowfullscreen></iframe> | ||
|
|
||
| ## Referências | ||
|
|
||
| [Colormind.io](http://colormind.io/) | ||
| [Constrast Checker](https://contrastchecker.com/) | ||
| [UI Colors](https://uicolors.app/create) | ||
| [Google Fonts - Noto Sans](https://fonts.google.com/noto/specimen/Noto+Sans) | ||
| [Google Fonts - Overpass](https://fonts.google.com/specimen/Overpass) | ||
| [React Icons - Ant Design Icons](https://react-icons.github.io/react-icons/icons/ai/) | ||
| [React Icons - Ant Design Icons](https://react-icons.github.io/react-icons/icons/ai/) | ||
|
|
||
| ## Histórico de versão | ||
|
|
||
| | Alteração | Data | Autor | | ||
| | - | - | - | | ||
| | Criação do documento | 02/04/24 | Sara Campos | | ||
| | Alteração | Data | Autor | | ||
| | -------------------- | -------- | ----------- | | ||
| | Criação do documento | 02/04/24 | Sara Campos | | ||
| | Atualização | 03/08/24 | Sara Campos | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters