Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds CONTRIBUTING file #10

Merged
merged 4 commits into from
Apr 28, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contribuindo

Uma vez que o _Idvogados_ é um projeto totalmente **open source**, qualquer pessoa/instituição pode contribuir da forma que desejar. Para isso basta seguir o guia de contribuição do projeto e nosso [código de conduta](https://github.com/idvogados/codigo-de-conduta/blob/master/README.md).

_Issues_ ou _pull requests_ que não estejam de acordo com este guia serão recusados.

## Linguagem

- _Commits_ devem ser feitos em inglês.
rodrigondec marked this conversation as resolved.
Show resolved Hide resolved
- _Issues_, _pull requests_ e revisões devem ser feitas em português para facilitar a comunicação e chegar a um consenso rapidamente.

## Desenvolvimento

- Desenvolva apenas em seu _branch_.
- Faça _rebase_ com o **dev** **antes** de criar _pull requests_.
- Mantenha seu fork sempre atualizado

> Como [atualizar um fork](https://help.github.com/pt/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)?

#### Como começar

1. Crie um _fork_ do projeto.
2. No seu _fork_, crie uma branch a partir da dev. (seguimos o [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow))
rodrigondec marked this conversation as resolved.
Show resolved Hide resolved
3. Na branch criada, faça suas alterações.
4. Realize o _commit_ seguindo este guia.
5. Abra um _pull request_ mencionando a _issue_ relacionada.

> Como criar um [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)?
> Como criar um [pull request de um fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)?
pictos marked this conversation as resolved.
Show resolved Hide resolved

## Commits

- Faça _commits_ pequenos, que descrevem alterações únicas.
- Sugerimos que siga as recomendações sobre como escrever mensagens de _commits_ descritas neste link:
- [_Commit Guidelines_](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)
- [_How to Write a Git Commit Message_](https://chris.beams.io/posts/git-commit/)
- Seja breve e suscinto no título das mensagens do _commit_.
- Use o corpo da mensagem para explicações adicionais.

#### O que **não** fazer quando commitando

- Burlar a verificação de _linting_ (--no-verify).
- Criar testes fake apenas para passar na verificação.

## Issues

Use _issues_ para discutir problemas e ideias para o projeto.

- Descreva qual é o problema em questão.
- Se possível, dê soluções para o problema.
- Faça _links_ para código ou para referências a outras _issues_/_pull requests_ se necessário.
- Todas as contribuições devem ser baseadas em uma _issue_ aberta e marcadas como pronta para implementar.