-
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.
Add documentation files of the repository
- Loading branch information
Showing
5 changed files
with
865 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,73 @@ | ||
# Contribuindo com o projeto | ||
|
||
Caso queira contribuir com o projeto, talvez seja uma boa ideia começar pelo [README](https://github.com/radar-pi/) para conhecer um pouco mais sobre nós. | ||
Outro documento importante e que deve ser lido é o [Código de Conduta](https://github.com/radar-pi/orquestrador/blob/master/docs/CODE_OF_CONDUCT.md). | ||
|
||
Obrigado por contribuir! :tada::+1: Sua ajuda será recebida com muita gratidão! | ||
|
||
## Como eu posso contribuir? | ||
|
||
### Reportando um Bug | ||
|
||
* Esse projeto segue um padrão de [_Issues_](https://github.com/radar-pi/orquestrador/blob/master/.github/ISSUE_TEMPLATE.md). Logo, caso encontre um _bug_, verifique se ele não se encontra em um a das nossas _Issues_. Os bugs devem ser marcados com _tag (label)_ __bug__. | ||
|
||
* Se o _bug_ encontrado não consta nas _Issues_, basta abrir uma [Nova _Issue_](https://github.com/radar-pi/project/issues/new). | ||
|
||
### Adicionando e/ou modificando alguma funcionalidade | ||
|
||
* Primeiro verifique que não existe nenhuma [_Issue_](https://github.com/radar-pi/project/issues) a respeito dessa modificação e/ou adição. | ||
|
||
* Caso não exista, crie uma [Nova _Issue_](https://github.com/radar-pi/project/issues/new). Dê um título significativo a ela, coloque uma descrição e pelo menos uma _label_. | ||
|
||
* As mudanças devem ser submetidas através de [_Pull Requests_](https://github.com/radar-pi/project/compare). Você pode encontrar mais sobre isso no [_Pull Requests Template_](https://github.com/radar-pi/orquestrador/blob/master/.github/PULL_REQUEST_TEMPLATE.md). | ||
|
||
## Padrão de _Commit_ | ||
|
||
### Por questões de padronização recomendamos que sigam nosso estilo de _commit_ | ||
|
||
* Os _commits_ devem ser todos em __inglês__; | ||
|
||
* Ele deve conter um título curto e objetivo do que foi feito naquele _commit_; | ||
|
||
* Após esse título, deve-se descrever, com um pouco mais de detalhes, todas as atividades executadas. | ||
|
||
* Caso esteja trabalhando em com algum associado assine nos seus _commits_ os seus parceiros | ||
|
||
__Exemplo:__ | ||
|
||
Creating project community files (Título curto e objetivo) | ||
|
||
Adds project license (Descrição de uma das atividades) | ||
|
||
Adds project code of conduct file | ||
|
||
Adds project contributing file | ||
|
||
Adds project issue template file | ||
|
||
Adds projects pull request file | ||
|
||
Co-authored-by: Peter Parker <peter.parker@email.com> (Assinatura de parceria) | ||
|
||
## Política de _Branches_ | ||
|
||
Tendo como meta manter a integralidade e confiabilidade do código do projeto foi proposta a utilização de política de _branches_. | ||
Essa Política de _Branches_ deverá guiar os desenvolvedores na forma de organização de suas contribuições ao repositório. | ||
__OBS__: A política de _branches_ foi idealizada para trabalhar em conjunto com a ferramenta do _git flow_, sua documentação e mais informações podem ser acessadas [aqui](https://github.com/nvie/gitflow). | ||
|
||
* __master__ - _Branch_ principal do repositório onde será permitida somente a integração de software consolidado e testado. Essa _branch_ será exclusiva para a entrega de _realeases_, ou seja, um conjunto maior de funcionalidades que integram o software. Aqui estará a versão _**stable**_ do software. | ||
|
||
* __develop__ - _Branch_ para integração de novas funcionalidades, onde será permitido a entrega das _features_ desenvolvidas e que estão em um estágio avançado de completude. Será a _branch_ base para o início do desenvolvimento das _features_ e da correção de _bugs_. Aqui também será feito o _merge_ das _releases_. | ||
|
||
* __feature/<nome-da-feature>__ - _Branch_ utilizada para o desenvolvimento de novas _features_ do _backlog_. Caso a feature tenha sida proposta por uma _issue_ do repositório e aceita no _backlog_ o nome deverá conter o número da _issue_. | ||
Ex: `feature/1-<nome-da-nova-feature>` (Considerando que a _feature_ tenha sido solicitada na _issue_ #1) | ||
|
||
* __bugfix/<nome-do-bug>__ - _Branch_ utilizada para corrigir _bugs_ de baixa/média urgência e que não estão presentes na _branch_ __master__. Caso o _bug_ tenha sido reportado por uma _issue_ do repositório o nome deverá conter o número da _issue_. | ||
Ex: `bugfix/1-<descrição-do-bug>` (Considerando que o _bug_ tenha sido reportado na _issue_ #1) | ||
|
||
* __hotfix/<nome-do-bug>__ - _Branch_ utilizada para corrigir _bugs_ de alta urgência e que estão presentes na _branch_ __master__. Caso o _bug_ tenha sido reportado por uma _issue_ do repositório o nome deverá conter o número da _issue_. | ||
Ex: `hotfix/1-<descrição-do-bug>` (Considerando que o _bug_ tenha sido reportado na _issue_ #1) | ||
|
||
* __release/<versão-da-release>__ - _Branch_ onde será feito os ajustes finais/_build_ antes da entrega de uma versão do produto de software. Constará no nome da _branch_ a versão da _release_ a ser entregue. | ||
|
||
* __support/<tema-ou-natureza>__ - _Branch_ onde serão executadas tarefas de suporte relacionadas ao software, como elaboração de documentações, correções de natureza de gerência de configuração e etc. |
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,36 @@ | ||
<!--- Forneça um resumo geral da _issue_ no título acima --> | ||
|
||
## Comportamento Esperado | ||
<!--- Se você está descrevendo um _bug_, conte-nos o que deveria acontecer. --> | ||
<!--- Se você está sugerindo uma mudança/melhoria, conte-nos como deve funcionar. --> | ||
|
||
## Comportamento Atual | ||
<!--- Se está descrevendo um bug, conte-nos o que acontece em vez do comportamento esperado. --> | ||
<!--- Se está sugerindo uma mudança/melhoria, explique a diferença com o comportamento atual. --> | ||
|
||
## Possível Solução | ||
<!--- Não é obrigatório, mas sugira uma possível correção/razão para o bug --> | ||
<!--- ou ideias de como implementar a adição/mudança. --> | ||
|
||
## Passos para Reproduzir (para bugs) | ||
<!--- Forneça um link para um exemplo, ou um conjunto de passos inequívocos --> | ||
<!--- para reproduzir esse bug. Inclua código para reproduzir, se relevante. --> | ||
|
||
1. <!-- Passo um --> | ||
|
||
2. <!-- Passo dois --> | ||
|
||
3. <!-- Passo três --> | ||
|
||
4. <!-- Passo N --> | ||
|
||
## Contexto | ||
<!--- Como esse problema o afeta? O que você está tentando realizar? --> | ||
<!--- Fornecer o contexto nos ajuda a encontrar uma solução que seja mais útil no mundo real --> | ||
|
||
## Seu Ambiente | ||
<!--- Inclua detalhes relevantes sobre o ambiente em que você presenciou/experienciou o bug. --> | ||
* Versão usada (Software): | ||
* Nome e versão do navegador: | ||
* Nome e versão do Sistema Operacional (desktop ou mobile): | ||
* Link para o seu projeto (Caso de fork deste projeto): |
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,37 @@ | ||
<!--- Forneça um resumo geral das suas alterações no título acima --> | ||
|
||
## Descrição | ||
<!--- Decreva suas alterações detalhadamente --> | ||
|
||
## _Issue_ Relacionada | ||
<!--- Este projeto apenas aceita _pull requests_ relacionadas à _issues_ abertas. --> | ||
<!--- Se está sugerindo uma nova _feature_ ou mudança, por favor discuta em uma _issue_ antes. --> | ||
<!--- Se está corrigindo um _bug_, deve haver uma _issue_ descrevendo-o com passos para reproduzir. --> | ||
<!--- Por favor, adicione o link para a _issue_ aqui: --> | ||
|
||
## Motivação e Contexto | ||
<!--- Por que essa mudança é necessária? Qual problema ela resolve? --> | ||
|
||
## Como Isso Foi Testado? | ||
<!--- Por favor, descreva detalhadamente como você testou suas mudanças. --> | ||
<!--- Inclua detalhes do seu ambiente de teste e os testes que você executou --> | ||
<!--- para ver como a sua alteração afeta outras áreas do código, etc. --> | ||
|
||
## Capturas de Tela (se apropriado) | ||
|
||
## Tipos de Mudanças | ||
<!--- Quais os tipos de alterações introduzidos pelo seu código? Coloque um `x` em todas as caixas que se aplicam: --> | ||
- [ ] _Bug fix_ (alteração que corrige uma _issue_ e não altera funcionalidades já existentes) | ||
- [ ] Nova _feature_ (alteração que adiciona uma funcionalidade e não altera funcionalidades já existentes) | ||
- [ ] Alteração disruptiva (_Breaking change_) (Correção ou funcionalidade que causa alteração nas funcionalidades existentes) | ||
|
||
## Checklist | ||
<!--- Passe por todos os pontos a seguir e coloque um `x` em todas as caixas que se aplicam. --> | ||
<!--- Se você não tem certeza sobre nenhum destes, não hesite em perguntar. Nós estamos aqui para ajudar! --> | ||
- [ ] Meu código segue o estilo de código desse projeto. | ||
- [ ] Meus _commits_ seguem o padrão de estilo desse projeto. | ||
- [ ] Minha alteração requer uma alteração na documentação. | ||
- [ ] Eu atualizei a documentação de acordo. | ||
- [ ] Eu li o documento de Contribuição (**CONTRIBUTING**). | ||
- [ ] Eu adicionei testes para cobrir minhas mudanças. | ||
- [ ] Todos os testes novos e existentes passaram. |
Oops, something went wrong.