From ce54a07bb3c3c640689bc019f5b585147522b8a5 Mon Sep 17 00:00:00 2001 From: Joaovitor045 Date: Thu, 9 Jan 2025 16:33:19 -0300 Subject: [PATCH] =?UTF-8?q?docs:add=20guia=20de=20contribui=C3=A7=C3=A3o?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guia-de-contribuicao/codigo-de-conduta | 92 ------------------- docs/guia-de-contribuicao/politica-de-branch | 45 --------- docs/guia-de-contribuicao/politica-de-commits | 62 ------------- 3 files changed, 199 deletions(-) delete mode 100644 docs/guia-de-contribuicao/codigo-de-conduta delete mode 100644 docs/guia-de-contribuicao/politica-de-branch delete mode 100644 docs/guia-de-contribuicao/politica-de-commits diff --git a/docs/guia-de-contribuicao/codigo-de-conduta b/docs/guia-de-contribuicao/codigo-de-conduta deleted file mode 100644 index 3378934..0000000 --- a/docs/guia-de-contribuicao/codigo-de-conduta +++ /dev/null @@ -1,92 +0,0 @@ -# Código de Conduta de Colaboração - -## Versão - -| **Título** | **Alterações Feitas** | **Autor** | **Data de Hoje** | -|-------------------|-----------------------------------------------| -----------| --------------- | -| código de conduta | Criação do documento de código de conduta | Mateus Maia | 07 de dezembro de 2024 | - -## Nosso compromisso - -Como participantes, colaboradoras e líderes, nós nos comprometemos a fazer com que a participação em nossa comunidade seja uma experiência livre de assédio para todas as pessoas, independentemente de idade, tamanho do corpo, deficiência aparente ou não aparente, etnia, características sexuais, identidade ou expressão de gênero, nível de experiência, educação, situação sócio-econômica, nacionalidade, aparência pessoal, raça, casta, religião ou identidade e orientação sexuais. - -Comprometemo-nos a agir e interagir de maneiras que contribuam para uma comunidade aberta, acolhedora, diversificada, inclusiva e saudável. - -## Nossos padrões - -Exemplos de comportamentos que contribuem para criar um ambiente positivo para a nossa comunidade incluem: - -- Demonstrar empatia e bondade com as outras pessoas -- Respeitar opiniões, pontos de vista e experiências contrárias -- Dar e receber feedbacks construtivos de maneira respeitosa -- Assumir responsabilidade, pedir desculpas às pessoas afetadas por nossos erros e aprender com a experiência -- Focar no que é melhor não só para nós individualmente, mas para a comunidade em geral - -Exemplos de comportamentos inaceitáveis incluem: - -- Uso de linguagem ou imagens sexualizadas, bem como o assédio sexual ou de qualquer natureza -- Comentários insultuosos/depreciativos e ataques pessoais ou políticos (Trolling) -- Assédio público ou privado -- Publicar informações particulares de outras pessoas, como um endereço de e-mail ou endereço físico, sem a permissão explícita delas -- Outras condutas que são normalmente consideradas inapropriadas em um ambiente profissional - -## Aplicação das nossas responsabilidades - -A liderança da comunidade é responsável por esclarecer e aplicar nossos padrões de comportamento aceitáveis e tomará ações corretivas apropriadas e justas em resposta a qualquer comportamento que considerar impróprio, ameaçador, ofensivo ou problemático. - -A liderança da comunidade tem o direito e a responsabilidade de remover, editar ou rejeitar comentários, commits, códigos, edições na wiki, erros e outras contribuições que não estão alinhadas com este Código de Conduta e irá comunicar as razões por trás das decisões da moderação quando for apropriado. - -## Escopo - -Este Código de Conduta se aplica dentro de todos os espaços da comunidade e também se aplica quando uma pessoa estiver representando oficialmente a comunidade em espaços públicos. Exemplos de representação da nossa comunidade incluem usar um endereço de e-mail oficial, postar em contas oficiais de mídias sociais ou atuar como uma pessoa indicada como representante em um evento online ou offline. - -## Aplicação - -Ocorrências de comportamentos abusivos, de assédio ou que sejam inaceitáveis por qualquer outro motivo poderão ser reportadas para a liderança da comunidade, responsável pela aplicação, via contato [INSERIR MÉTODO DE CONTATO]. Todas as reclamações serão revisadas e investigadas imediatamente e de maneira justa. - -A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança de quem reportar qualquer incidente. - -## Diretrizes de aplicação - -A liderança da comunidade seguirá estas Diretrizes de Impacto na Comunidade para determinar as consequências de qualquer ação que considerar violadora deste Código de Conduta: - -### 1. Ação Corretiva - -**Impacto na comunidade**: Uso de linguagem imprópria ou outro comportamento considerado anti-profissional ou repudiado pela comunidade. - -**Consequência**: Aviso escrito e privado da liderança da comunidade, esclarecendo a natureza da violação e com a explicação do motivo pelo qual o comportamento era impróprio. Um pedido de desculpas público poderá ser solicitado. - -### 2. Advertência - -**Impacto na comunidade**: Violação por meio de um incidente único ou atitudes repetidas. - -**Consequência**: Advertência com consequências para comportamento repetido. Não poderá haver interações com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o Código de Conduta, por um período determinado. Isto inclui evitar interações em espaços da comunidade, bem como canais externos como as mídias sociais. A violação destes termos pode levar a um banimento temporário ou permanente. - -### 3. Banimento Temporário - -**Impacto na comunidade**: Violação grave dos padrões da comunidade, incluindo a persistência do comportamento impróprio. - -**Consequência**: Banimento temporário de qualquer tipo de interação ou comunicação pública com a comunidade por um determinado período. Estarão proibidas as interações públicas ou privadas com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o Código de Conduta. A violação destes termos pode resultar em um banimento permanente. - -### 4. Banimento Permanente - -**Impacto na comunidade**: Demonstrar um padrão na violação das normas da comunidade, incluindo a persistência do comportamento impróprio, assédio a uma pessoa ou agressão ou depreciação a classes de pessoas. - -**Consequência**: Banimento permanente de qualquer tipo de interação pública dentro da comunidade. - -## Atribuição - -Este Código de Conduta é adaptado do [Contributor Covenant][homepage], versão 2.1, disponível em [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. - -As Diretrizes de Impacto na Comunidade foram inspiradas pela -[Aplicação do código de conduta Mozilla][Mozilla CoC]. - -Para obter respostas a perguntas comuns sobre este código de conduta, veja a página de Perguntas Frequentes (FAQ) em [https://www.contributor-covenant.org/faq][FAQ]. Traduções estão disponíveis em [https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations - - diff --git a/docs/guia-de-contribuicao/politica-de-branch b/docs/guia-de-contribuicao/politica-de-branch deleted file mode 100644 index daeb7fb..0000000 --- a/docs/guia-de-contribuicao/politica-de-branch +++ /dev/null @@ -1,45 +0,0 @@ -# Política de _branches_ - -## Versão - -| **Título** | **Alterações Feitas** | **Autor** | **Data de Hoje** | -|-------------------|-----------------------------------------------| -----------| --------------- | -| politica de branch | Criação do documento de política de branch | Mateus Maia | 07 de dezembro de 2024 | -## Política de _branches_ - - -Segue-se o fluxo de trabalho descrito pelo [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), representado pelo diagrama abaixo: - - -Dessa forma, existem as seguintes categorias de _branches_: - -## *_main_* -_Branch_ de produção, com a versão estável mais atual do projeto. Bloqueada para commits e pushs, pode ser interagida apenas através de _pull requests_ provenientes da [_devel_](#devel), [_hotfix branches_](#hotfix-branches) ou [_release branches_](#release-branches). - -## *_devel_* -_Branch de desenvolvimento_, agrupa o trabalho de outras _branches_ com o objetivo de se criar uma versão de _release_ para ser submetida à master. Também é bloqueada para commits e pushs, devendo ser modficada através de _pull requests_ provenientes das [_feature branches_](#feature-branches). - -## *_Feature Branches_* -_Branches_ criadas a partir da _devel_, para o desenvolvimento de uma funcionalidade específica. Idealmente, uma _feature branch_ deve ser referente à uma issue cadastrada no repositório, para melhor acompanhamento e rastreamento do projeto. Ao final do desenvolvimento, deve-se submeter um _pull request_ visando a _devel_. Se as modificações forem aceitas com sucesso, a _branch_ deve ser apagada. - #### *Nomenclatura* - _Feature Branches_ devem seguir o padrão `x_nome_da_issue`, com x sendo o número da _issue_ correspondente no repositório. - -## *_Hotfix Branches_* -_Branches_ criadas a partir da _master_, para a correção rápida de bugs em produção. Ao final, as atualizações submetidas devem ser integradas tanto à _master_ quanto à _devel_. - #### *Nomenclatura* - _Hotfix Branches_ devem seguir o padrão `hotfix_x_nome_da_issue`, com x sendo o número da _issue_ que identifica o bug a ser corrigido. - -## *_Release Branches_* -_Branches_ criadas a partir da _devel_, servem para a preparação de uma _release_ do projeto. Deve conter tarefas apenas relacionadas a essa _release_, como correção de bugs ou refino de alguma funcionalidade já implementada. Funcionalidades novas **não** devem ser desenvolvidas nessa _branch_. Com a _release_ preparada, deve-se integrar a branch à master. - #### *Nomenclatura* - _Release Branches_ devem seguir o padrão `release/numero_de_versao`, identificando a versão do produto que será entregue naquela _release_. - -## Mantendo _branches_ atualizadas -Para um fluxo de trabalho sem grandes inconvenientes, recomenda-se manter as _branches_ pessoais de desenvolvimento (features, hotfixes) sempre atualizadas. Antes de se submeter um _pull request_, deve se garantir que a _branch_ possui todas as alterações mais recentes de sua _branch_ de origem. Para isso, deve se utilizar os seguintes comandos: -``` -git checkout branch_de_trabalho - -git pull branch_de_origem # devel para features, master para hotfixes - -git push origin branch_de_trabalho -``` \ No newline at end of file diff --git a/docs/guia-de-contribuicao/politica-de-commits b/docs/guia-de-contribuicao/politica-de-commits deleted file mode 100644 index 071621c..0000000 --- a/docs/guia-de-contribuicao/politica-de-commits +++ /dev/null @@ -1,62 +0,0 @@ -# Política de _Commits_ - -## Versão - -| **Título** | **Alterações Feitas** | **Autor** | **Data de Hoje** | -|-------------------|-----------------------------------------------| -----------| --------------- | -| politica de commits | Criação do documento de política de commits | Mateus Maia | 07 de dezembro de 2024 | - - -## Política de _Commits_ - -Devem seguir o modelo : do [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) - - -Deve ser um dos seguintes tipos: - -- **build**: alterações que afetam o sistema de build ou dependências externas -- **static**: alterações no conteúdo de arquivos estáticos (dados .json, imagens, etc) -- **ci**: alterações em nossos arquivos e scripts de configuração de CI -- **cd**: alterações em nossos arquivos e scripts de configuração para CD -- **docs**: somente alterações na documentação -- **feat**: um novo recurso -- **fix**: uma correção de bug da aplicação -- **perf**: alteração de código que melhora o desempenho da aplicação e não altera a forma como o usuário utiliza a aplicação -- **refactor**: alteração de código, que não corrige um bug e nem altera a forma como o usuário utiliza a aplicação -- **improve**: alguma alteração de código que melhore o comportamento de um recurso -- **style**: alterações que não afetam o significado do código (espaço em branco, formatação, ponto e vírgula, etc) -- **test**: adicionando testes ausentes ou corrigindo testes existentes -- **revert**: reverter para um commit anterior - -Por exemplo: - -``` - git commit -m "docs: correct spelling of CHANGELOG" -``` - -Ao invés de: -``` - git commit -m "Adding API routing for User service." -``` - -### Commits em pares -Ao se desenvolver funcionalidades utilizando a técnica de _pair programming_, deve se atribuir autoria a ambos os colaboradores. Para isso, deve se utilizar a tag _co-authored-by_ do Github, através dos seguintes passos: -* Após adicionar todos os arquivos modificados, executar o commit sem flags adicionais: -``` -git commit -``` -* Isso abrirá o editor de texto padrão configurado para o Git. Digite a mensagem de commit, e após **duas** linhas em branco, adicione a co-autoria. Exemplo: -``` -feat: add repo policies - - -Co-authored-by: Nome Sobrenome -``` - -Dessa forma o commit será contabilizado pelo Github como sendo realizado pelos dois contribuidores, gerando um registro mais detalhado de participação. - - - - - -