-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
33009ca
commit 88879fb
Showing
4 changed files
with
179 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
tag: "politicas" | ||
--- | ||
Padronização das branches no projeto. | ||
|
||
## Histórico de Versões | ||
|
||
|
||
| Data | Versão | Descrição | Autor | | ||
| :--------: | :----: | :----------: | :---------------: | | ||
| 04/03/2024 | 0.1 | Criação da política de branch | [Joselito Prado](https://github.com/joselitoprado) | ||
|
||
|
||
|
||
## Padronização das Branches | ||
A padronização de branches no GitHub é crucial para o desenvolvimento eficiente de software, proporcionando vantagens fundamentais na organização e colaboração. Essa prática aprimora significativamente a qualidade do código-fonte, contribuindo para o sucesso do projeto. | ||
Como esse projeto de migração do site da Revista Darcy será realizada em WordPress, o time decidiu por manter apenas a main branch. Dessa forma, opções de padronização de branches não serão aplciados a esse projeto, como prefixos. | ||
|
||
### Formato: | ||
``` | ||
#número da issue/assunto | ||
``` | ||
|
||
Não esquecer de dividir as palavras(sempre minúsculas) do assunto com "-". | ||
Exemplo: | ||
``` | ||
#87/novo-menu | ||
``` | ||
|
||
### Branch: | ||
|
||
- **Branch main:** Branch que contém o código em nível de produção, será o código mais consolidado existente na aplicação. Nenhum integrante dos times é autorizado a fazer commits diretamente na *main.* | ||
|
||
## Referências | ||
|
||
DULCETTI, Bruno. Padrões e nomenclaturas no Git. *BrunoDulcetti*. Disponível em: <https://www.brunodulcetti.com/padroes-e-nomenclaturas-no-git/>. Acesso em: 04 de março de 2024. | ||
|
||
HADLER, Mikael. Utilizando o fluxo Git Flow. *Medium*. Disponível em: <https://medium.com/trainingcenter/utilizando-o-fluxo-git-flow-e63d5e0d5e04>. Acesso em: 04 de março de 2024. |
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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
tag: "politicas" | ||
--- | ||
Padronização dos commits no projeto. | ||
|
||
## Histórico de Versões | ||
|
||
|
||
| Data | Versão | Descrição | Autor | | ||
| :--------: | :----: | :----------: | :---------------: | | ||
| 04/03/2024 | 0.1 | Criação da política de commits | [Joselito Prado](https://github.com/joselitopradomarques)| | ||
|
||
## Semântica do Commit | ||
|
||
Os commits devem seguir o seguinte padrão: | ||
|
||
### Princípios: | ||
|
||
#### Commits atômicos | ||
Sempre dividir em pequenos e significativos commits, fazendo com que cada commit tenha apenas uma funcionalidade. | ||
|
||
#### Commits em português | ||
Por ser um projeto voltado totalmente para um público brasileiro e por toda equipe ter mais afinidade com o português, foi decidido que todos os commits serão em pt-BR. | ||
|
||
### Formato: | ||
``` | ||
(#número da issue): assunto | ||
``` | ||
|
||
#### Assunto: | ||
|
||
- Deve possuir no máximo 50 caracteres | ||
|
||
*Exemplo de commit:* | ||
``` | ||
git commit -m "(#02): botão na página inicial" | ||
``` | ||
|
||
## Referências | ||
|
||
DARTORA, João. Tudo o que você precisa saber sobre commits semânticos. *Ilegra*. Disponível em: <https://ilegra.com/blog/tudo-o-que-voce-precisa-saber-sobre-commits-semanticos/>. Acesso em: 04 de março de 2024. |
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 |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
tag: "politicas" | ||
--- | ||
|
||
## Histórico de versões | ||
|
||
| Data | Versão | Descrição | Autor | | ||
| :--------: | :----: | :----------------------------: | :-------: | | ||
| 04/03/2024 | 0.1 | Abertura do documento | [Joselito Prado](https://github.com/joselitopradomarques) | | ||
|
||
## Propósito | ||
|
||
Residentes do projeto de imersão TIC Brisa Lappis administram o projeto. Com o objetivo de promover um ambiente inclusivo e acolhedor, os residentes comprometem-se a envolver-se ativamente na execução do projeto e na comunidade, garantindo uma experiência isenta de qualquer forma de assédio para todos os participantes, tanto como colaboradores quanto como responsáveis pelo projeto. | ||
|
||
## Comportamento | ||
|
||
### Comportamentos aceitáveis | ||
|
||
- Reconhecimento e apreciação de diversas opiniões, perspectivas e vivências. | ||
- Estímulo à prática de críticas construtivas, tanto ao oferecer quanto ao receber feedback. | ||
- Assunção de responsabilidade por eventuais equívocos, buscando aprendizado com as experiências. | ||
- Emprego de linguagem acolhedora e inclusiva. | ||
- Expressão de empatia em relação aos membros da comunidade. | ||
|
||
### Comportamentos inaceitáveis | ||
|
||
- Compromisso de não utilizar linguagem ou imagens com conotação sexual. | ||
- Evitar comportamentos provocativos, insultuosos, depreciativos, bem como ataques pessoais ou políticos. | ||
- Condenar o assédio, seja ele público ou privado. | ||
- Respeitar a privacidade, não compartilhando informações pessoais de terceiros sem sua devida autorização, como fotos ou endereços de e-mail. | ||
- Abster-se de qualquer outra conduta que, dentro dos limites da razoabilidade, possa ser considerada inadequada em um ambiente profissional. | ||
|
||
## Responsabilidades | ||
|
||
Os mantenedores do projeto têm a responsabilidade de esclarecer os padrões de conduta estabelecidos no código. Em caso de dúvida, é incumbência deles tomar medidas corretivas justas em resposta a quaisquer comportamentos inaceitáveis. Eles também possuem o direito e a responsabilidade de editar, remover ou rejeitar comentários, confirmações, código e outras contribuições que não estejam em conformidade com este Código de Conduta. Além disso, devem comunicar aos responsáveis pela residência caso qualquer colaborador demonstre comportamentos considerados inadequados, ameaçadores, ofensivos ou prejudiciais. | ||
|
||
## Escopo | ||
|
||
Este Código de Conduta se aplica tanto dentro do âmbito do projeto quanto em locais públicos onde um indivíduo represente o projeto ou sua comunidade. Isso inclui situações como o uso do repositório oficial relacionado ao projeto ou a participação em reuniões onde atue como representante. | ||
|
||
## Execução | ||
|
||
Situações de comportamento inadequado podem ser relatadas entrando em contato com [email protected]. Todos os relatos serão minuciosamente avaliados e investigados, com a subsequente implementação de uma resposta apropriada para a circunstância. A equipe do projeto é comprometida com a preservação da confidencialidade em relação ao denunciante de um incidente. | ||
|
||
|
||
## Referência | ||
|
||
ORGANIZATION FOR ETHICAL SOURCE. Contributor Covenant, 2014. Latest Version. Disponível em: https://www.contributor-covenant.org/version/2/1/code_of_conduct/. Acesso em: 04 de março de 2024. |
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 |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
excerpt: "" | ||
--- | ||
| Data | Versão | Descrição | Autor | | ||
| :--------: | :----: | :----------: | :---------------: | | ||
| 04/03/2024 | 0.1 | Criação do documento | [Joselito Prado](https://github.com/joselitopradomarques)| | ||
|
||
|
||
## 1. Objetivo | ||
O propósito deste documento é formalizar os canais de comunicação entre os membros do projeto, delineando desde as ferramentas empregadas até os procedimentos essenciais para garantir a adequada armazenagem, organização e distribuição das informações. | ||
|
||
## 2. Entradas e Ferramentas para o Processo | ||
|
||
| Ícone | Ferramenta | Descrição | | ||
| :--------------: | :-----------: | :--------------------------------------: | | ||
| ![image](https://upload.wikimedia.org/wikipedia/commons/c/c2/GitHub_Invertocat_Logo.svg) | GitHub | Sistema de controle de versão, que abriga os códigos do produto, e por meio desse sistema são realizados comentários nas questões (issues) que estão sendo trabalhadas.| | ||
| ![image](https://cdn-icons-png.flaticon.com/256/5968/5968804.png) | Telegram | Utilizado para a comunicação rápida e do dia a dia, para dinamizar a troca de informações entre a equipe. | | ||
| ![image](https://cdn.iconscout.com/icon/free/png-256/discord-2752210-2285027.png) | Discord | Utilizado para reuniões como pré-planejamento e planejamento da sprint, sprint review, daily e quaisquer outras reuniões que forem marcadas. | | ||
| ![image](https://seeklogo.com/images/M/microsoft-teams-logo-EA3C0316D6-seeklogo.com.png) | Teams | Utilizado para reuniões com stakeholders e transação de documentos.| | ||
|
||
|
||
|
||
## 3. Diretrizes e procedimentos usados para comunicar | ||
### 3.1 Comunicação Geral | ||
|
||
A **comunicação** é a chave principal para o bom progresso do projeto. Tendo isso em vista, é importante zelar pela clareza nas interações. Portanto, os pontos cruciais a serem levados como pilares são: | ||
|
||
1. Seguir os rituais ágeis, para conseguir manter a comunicação eficaz do projeto (*daily* e *review*); | ||
2. Manter as partes interessadas "alinhadas", evitando ao máximo ruídos e sempre comunicar ao haver novidades acerca de tópcicos. | ||
|
||
|
||
### 3.2 Gerência de Reuniões | ||
#### 3.2.1 Pré-planejamento da Sprint | ||
|
||
Num encontro semanal, todos os membros se reúnem para decidir, coletivamente, as atividades e funcionalidades a serem realizadas pelos integrantes, alinhando-se com as disponibilidades e o calendário de todos. | ||
|
||
Além disso, são avaliadas as melhorias que devem ser implementadas e o esforço necessário para executar cada tarefa. | ||
|
||
#### 3.2.2 Planejamento da Sprint | ||
Após o pré-planejamento, todos integrantes dividem as que ficarão alocadas entre os membros de acordo com dificuldade e disponibilidade. Além disso também são levantadas quais melhorias podem ser feitas. | ||
|
||
#### 3.2.3 Reuniões Semanais | ||
Tarefa realizada pelo discord d, onde cada integrante explica de forma clara: o que foi feito desde a última reunião e o que pretende fazer até a próxima, dessa forma os integrantes estão se mantendo informados do andamento da sprint. | ||
|
||
#### 3.2.4 Sprint Review | ||
Reunião para mostrar os resultados positivos da sprint, cada membro mostra o trabalho que fez para que o time possa fornecer e obter feedback. | ||
|
||
## 4. Referências | ||
|
||
IEEE (2012), IEEE Guide--Adoption of the Project Management Institute (PMI) Standard A Guide to the Project Management Body of Knowledge (PMBOK Guide)--Fifth Edition. | ||
|
||
FELIPE, Caio; FREITAS, Gesiel; BUSCHE, João Paulo; CARVALHO, Vinícius; PINHEIRO, Vinicius. SIGS - Plano de Gerenciamento de Comunicação. Disponível em: https://github.com/fga-eps-mds/2017.1-SIGS/wiki/Plano-de-Gerenciamento-de-Comunica%C3%A7%C3%A3o#32-gerencia-de-reuni%C3%B5es. Acesso em: 04 de março de 2024. |