CONTRIBUTING.md

Contributing

TLDR

Esta documentação explica como contribuir com o repositório. Isto pode ser feito de diversas formas:

• Adicionando novos exercícios e expandindo as listas.
• Criando ou melhorando documentações.
• Adicionando novos casos de teste interessantes.

Para isso utilizamos 2 sistemas de organização:

• Pull Requests
• Ìssues

A organização das issues e PR's fica por conta do excelentissimo 🤥 ditador benevolente da vez: @frattezi 👏.

Como contribuir

Existem algumas formas principais de contribuição:

• Resolvendo Issues já existentes.
• Contibuindo nas discussões presentes nas Issues.
• Criando novas Issues para o repositório.

Isto tem por objetivo mapearmos discussões e melhorias de uma forma mais organizada e aberta, assim, todos podem contribuir:grimacing:.

Logo não é válido:

• Enviar mensagens com pedidos de melhoria para o ditador benevolente.
• Criar Pull Requests não vinculados a uma Issue válida.
• Desrespeitar os participantes desse repositório nos comentários das issues
  • Assuntos polêmicos e traumáticos (triggers)
  • Mensagens de ódio e com teor depreciativo a outras pessoas.

Porém você pode:

• Criar novas issues seguindos os padrões colocados.
• Contribuir com as dicussões de forma produtiva!
• Criar novas Issues com suas idéias de melhorias para o projeto!

Nossa organização fica toda concentrada no Github:octocat:, vamos usar as ferramentas que temos a disposição! Melhorias no processo de contribuição também são muito bem vindas!

Issues

Issues são a principal forma de comunicação dentro deste repositório, elas devem ser um espaçõ aberto de comunicação e discussão referentes a melhorias, adições, correções e outros temas com intuito de evoluir nossas listas de exercícios.

Para organizarmos melhor o tema/objetivo de cada Issue utilizamos Tags, cada tag descreve um pouco sobre os objetivos das issues:

Tags

• nova issue: Issues criadas por participantes da podcodar, uma issue com esta tag indica que ela ainda precisa passar pela avaliação de um monitor responsável pelo repositório para que seja trabalhada por um participante.
• amigavel para iniciantes: Issues que são indicadas para participantes com pouco experiência ou novos ao repositório.
• bug: Relata um problema de documentação ou implementação.
• documentacao: Issues relacionadas a melhoria ou expansão da documentação do repositório.
• feature: Novas adições ao repositório, por exemplo exercícios, documentações, etc...

É possível que uma mesma Issue possua mais de uma Tag, por exemplo:

Sou um novo usuário e gostaria de corrigir um erro que vi em uma documentação de exercício, porém não existe nenhuma issue que mapeia este problema ainda.

Neste caso, você pode criar uma nova issue com as tags: nova issue,documentacao. Isto indica para os mantenedores deste repositório que uma nova issue foi aberta e deve ser avaliada. Isto possibilita que as melhorias sejam direcionadas, pessoas com mais experiência podem ajudar outras a melhor especificar e entender problemas.

Após este processo a tag nova issue é removida e a issue pode ser trabalhada por você ou mesmo por outro membro.

---

Pull Requests

Para fazer uma modificação no repositório de exercícios é necessário abrir um Pull Request e seguir os padrões Git que podem ser encontrados nesta documentação.