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

[Feature] Guia de Contribuição #54

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
87 changes: 87 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Código de Conduta de Colaboração

## Nossa promessa

Nós, como membros, colaboradores e líderes, nos comprometemos a tornar a participação em nossa comunidade uma experiência livre de assédio para todos, independentemente da idade, tamanho do corpo, deficiência visível ou invisível, etnia, características sexuais, identidade ou expressão de gênero, nível de experiência, educação, status socioeconômico, nacionalidade, aparência pessoal, raça, religião ou identidade e orientação sexuais.

**Comprometemo-nos a agir e interagir de forma a contribuir para uma comunidade aberta, acolhedora, diversa, inclusiva e saudável.**

## Nossos Padrões

### Exemplos de comportamento que contribuem para um ambiente positivo para nossa comunidade incluem

- Demonstrando empatia e bondade para com outras pessoas;
- Ser respeitoso com as diferentes opiniões, pontos de vista e experiências;
- Dar e aceitar com elegância feedback construtivo;
- Aceitando a responsabilidade e pedindo desculpas àqueles afetados por nossos erros e aprendendo com a experiência;
- Focar no que é melhor não apenas para nós como indivíduos, mas para a comunidade em geral;
- Quando solicitada sua ajuda, procure sempre estar disposto a ajudar, mesmo que procurando alguém que tenha mais conhecimento sobre.

### Exemplos de comportamento inaceitável incluem

- O uso de linguagem ou imagens sexualizadas e atenção sexual ou avanços de qualquer tipo;
- Comentários de insultos, depreciativos ou considerados como _trollagem_ ou _trolling_ e ataques pessoais ou políticos;
- Assédio público ou privado;
- Publicar informações privadas de terceiros, como um endereço físico ou de e-mail, sem sua permissão explícita;
- Outra conduta que poderia ser razoavelmente considerada inadequada 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, participação de membros em redes sociais quando representar a comunidade, 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 por email para `ufrpedevs@gmail.com` ou se preferir, você poderá contatar membros da liderança em suas respectivas redes sociais.

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](https://www.contributor-covenant.org), versão 2.0, disponível em <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

As Diretrizes de Impacto na Comunidade foram inspiradas pela [Aplicação do código de conduta Mozilla](https://github.com/mozilla/diversity).

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>.

Traduções estão disponíveis em <https://www.contributor-covenant.org/translations>.

***
Made with ♥ by ufrpe-devs Open Source! :rocket:
124 changes: 123 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,123 @@
# Guia de Contribuição
# Guia de Contribuição

> Baseado no Guia de primeiras contribuições do [firstcontributions/first-contributions](https://github.com/firstcontributions/first-contributions)

É difícil. É sempre difícil fazer algo pela primeira vez. Especialmente quando se está colaborando, cometer erros não é algo agradável. Mas *open source* (código aberto) se trata de colaboração e de trabalharmos juntos. Queremos simplificar a forma com que novos colaboradores *open source* aprendem e contribuem pela primeira vez.

Ler artigos e ver tutoriais pode ajudar, mas o que é melhor do que realmente pôr a mão na massa em um ambiente prático? Este projeto visa guiar e simplificar a forma com que os novatos fazem a sua primeira contribuição. Se quiser fazer a sua primeira contribuição, siga os passos abaixo.

**_Se você não se sente confortável com linha de comando, [aqui estão alguns tutoriais de ferramentas gráficas.](#Tutoriais-usando-outras-ferramentas)_**

<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/fork.png" alt="fork deste repositório" />

Se não possui o git em sua máquina, [instale-o aqui](https://help.github.com/articles/set-up-git/).

## Faça um Fork deste repositório

Faça um Fork clicando no botão "Fork" no topo da página principal do repositório. Isto irá criar uma cópia deste repositório na sua conta.

## Clone o repositório

<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/clone.png" alt="clonar este repositório" />

Agora clone este repositório para a sua máquina. Clique no botão "Clone or download" e, em seguida, clique no ícone "Copy to clipboard" para copiar a URL.

Abra seu terminal e execute o seguinte comando do git:

```git
git clone "url que copiou"
```

onde "url que copiou" (sem as aspas) é a URL deste repositório. Consulte as etapas anteriores para obter a URL.

<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/copy-to-clipboard.png" alt="copiar URL" />

Por exemplo:

```git
git clone https://github.com/ufrpe-devs/comunidade.git
```

Aqui você está copiando o conteúdo do repositório **ufrpe-devs/comunidade** para o seu computador.

## Crie um Branch

Vá para o diretório do repositório no seu computador (caso você não esteja lá):

```bash
cd comunidade
```

Agora crie um Branch usando o comando `git checkout`:

```git
git checkout -b <nome da sua branch>
```

Por exemplo:

```git
git checkout -b add/steffano-pereira
```

Obs.: O nome do Branch não precisa ter a sigla "add", mas nesse caso é recomendável, porque a finalidade deste Branch é a de adicionar o seu nome à nossa lista de contribuidores.

## Efetue as alterações necessárias e faça um Commit

Agora abra o arquivo `Contributors.md` em seu editor de código, adicione o seu nome a ele e salve o arquivo.

<img align="right" width="450" src="https://firstcontributions.github.io/assets/Readme/git-status.png" alt="git status" />

Se você for para o diretório do projeto e executar o comando `git status`, verá que há alterações. Adicione essas alterações ao Branch que você acabou de criar utilizando o comando `git add`:

```git
git add Contributors.md
```

Agora faça um Commit dessas alterações utilizando o comando `git commit`:

```git
git commit -m "Add <seu-nome> to Contributors list"
```

preenchendo `<seu-nome>` com o seu nome.

## Faça um Push das alterações para o GitHub

Faça um Push utilizando o comando `git push`:

```git
git push origin <add-seu-nome>
```

substituindo `<add-seu-nome>` pelo nome da Branch que você criou anteriormente.

## Envie suas alterações para serem revisadas

Se você for para o seu repositório no GitHub, verá um botão `Compare & pull request`. Clique nesse botão.

<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/compare-and-pull.png" alt="Crie um Pull Request" />

Agora envie um Pull Request.

<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/submit-pull-request.png" alt="Envie o Pull Request" />

Logo estarei mesclando ('mergeando') as suas mudanças no Branch principal (main) deste projeto. Você receberá um e-mail de notificação quando as alterações forem mescladas.

## Para onde ir a partir daqui?

Parabéns! Você completou o fluxo de trabalho básico _fork -> clone -> edit -> PR_ que você encontrará frequentemente como contribuidor!

Celebre sua contribuição e compartilhe com seus amigos!

Você também pode se juntar à nossa equipe no Discord caso precise de alguma ajuda ou tenha alguma dúvida. [Junte-se à nossa equipe no Discord!](https://discord.com/invite/xeEaKKG).

Agora você pode colaborar com outros projetos. Nós temos uma lista de projetos, inclusive com problemas simples, basta procurar a tag `good first issue` que você pode começar. Verifique [a lista de projetos no GitHub](https://github.com/orgs/ufrpe-devs/repositories).

### [Material adicional](https://github.com/firstcontributions/first-contributions/blob/41d31fc572cf921c8a48e067e3ce1414ba4c1de6/additional-material/translations/additional-material.pt_br.md)

## Tutoriais usando outras ferramentas

|<a href="../github-desktop-tutorial.md"><img alt="GitHub Desktop" src="https://desktop.github.com/images/desktop-icon.svg" width="100"></a>|<a href="../github-windows-vs2017-tutorial.md"><img alt="Visual Studio 2017" src="https://upload.wikimedia.org/wikipedia/commons/2/2d/Visual_Studio_Code_1.18_icon.svg" width="100"></a>|<a href="../gitkraken-tutorial.md"><img alt="GitKraken" src="https://firstcontributions.github.io/assets/Readme/gk-icon.png" width="100"></a>| <a href="github-windows-intellij-tutorial.md"><img alt="IntelliJ IDEA" src="https://upload.wikimedia.org/wikipedia/commons/9/9c/IntelliJ_IDEA_Icon.svg" width=100></a> |
|:---:|:---:|:---:|:---:|
|[GitHub Desktop](https://github.com/firstcontributions/first-contributions/blob/41d31fc572cf921c8a48e067e3ce1414ba4c1de6/gui-tool-tutorials/github-desktop-tutorial-ptBR.md)|[[EN] Visual Studio Code](https://github.com/firstcontributions/first-contributions/blob/41d31fc572cf921c8a48e067e3ce1414ba4c1de6/gui-tool-tutorials/github-windows-vs-code-tutorial.md)|[[EN] GitKraken](https://github.com/firstcontributions/first-contributions/blob/41d31fc572cf921c8a48e067e3ce1414ba4c1de6/gui-tool-tutorials/gitkraken-tutorial.md)|[IntelliJ IDEA](https://github.com/firstcontributions/first-contributions/blob/41d31fc572cf921c8a48e067e3ce1414ba4c1de6/gui-tool-tutorials/translations/github-windows-intellij-tutorial.pt_br.md) |
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
</div>

# UFRPE Devs - Comunidade

[![UFRPE Devs badge](./media/ufrpe-devs-badge.svg)](https://github.com/ufrpe-devs/comunidade)
[![Ufrpe Devs Discord Server](https://img.shields.io/discord/678334713919832100?logo=discord)](https://discord.gg/xeEaKKG)


> Somos uma comunidade de pessoas desenvolvedoras da Universidade Federal Rural de Pernambuco (UFRPE)

🗄️ [Repositórios](https://github.com/ufrpe-devs/comunidade/blob/main/Repos.md) - 👥 [Contribuidores](https://github.com/ufrpe-devs/comunidade/blob/main/Contributors.md)
Expand All @@ -19,3 +19,7 @@ conhecimento acerca de desenvolvimento dentro do ambiente acadêmico. Acreditamo
## Como participar?

Quer contribuir com nossa comunidade? Leia nosso [Guia de Contribuição](https://github.com/ufrpe-devs/comunidade/blob/main/CONTRIBUTING.md) e veja como fazer isso.

## Nosso Código de Conduta

Por favor, leia atentamente nosso [Código de conduta](https://github.com/ufrpe-devs/comunidade/blob/main/CODE_OF_CONDUCT.md) para mantermos nosso ambiente harmonioso.