CONTRIBUTING.md

Guia de Contribuição JogaAquiApp

👍🎉 Primeiramente, obrigado por dedicar um tempo para contribuir! 🎉👍

Veja a seguir um conjunto de diretrizes para contribuir com o projeto JogaAquiApp. Estas são principalmente diretrizes, não regras. Use seu bom senso e sinta-se à vontade para propor alterações a este documento em uma solicitação pull.

Código de Conduta

Este projeto e todos os participantes dele são regisdos pelo Código de Conduta JogaAquiApp. Ao participar, espera-se que você mantenha este código. Por favor, denuncie comportamento inaceitável.

Observação: Por favor, não registre um problema para fazer uma pergunta.. Entre em contato se você tiver uma dúvida.

Como posso Contribuir?

Relatando Bugs

Esta seção orienta você no envio de um relatório de bug. Seguir essas diretrizes ajuda os mantenedores e a comunidade a entender seu relatório 📝, reproduza o comportamento 💻 💻 e encontre relatórios relacionados 🔎.

Antes de criar relatórios de bugs, verifique se já existe uma issues aberta, pois você pode descobrir que não precisa criar um. Ao criar um relatório de bug, inclua o máximo de detalhes possível. Preencha o modelo obrigatório, as informações solicitadas nos ajudam a resolver problemas mais rapidamente.

Observação: se você encontrar um problema Fechado que pareça ser o mesmo que você está enfrentando, abra um novo problema e inclua um link para o problema original no corpo do novo..

Antes de enviar um relatório de bug

• Faça uma pesquisa superficial para ver se o problema já foi relatado. Se tiver e o problema ainda estiver em Aberto , adicione um comentário ao problema existente em vez de abrir um novo.

Como faço para enviar um relatório de bug (bom)?

Bugs são rastreados como problemas do GitHub. Forneça as seguintes informações preenchendo o modelo.

Explique o problema e inclua detalhes adicionais para ajudar os mantenedores a reproduzir o problema:

• Use um título claro e descritivo para o problema para identificar o problema.
• Descreva as etapas exatas que reproduzem o problema com o máximo de detalhes possível. Por exemplo, comece explicando como você iniciou o projeto, por exemplo, qual comando exatamente você usou, ou como você iniciou o projeto. Ao listar as etapas, não diga apenas o que você fez, mas explique como você fez isso . Por exemplo, se você moveu o cursor para o final de uma linha, explique se usou o mouse, um atalho de teclado, teclado virtual, em caso afirmativo, qual deles?
• Forneça exemplos específicos para demonstrar as etapas . Inclua links para arquivos ou projetos do GitHub ou snippets para copiar/colar, que você usa nesses exemplos. Se você estiver fornecendo snippets no problema, use blocos de código Markdown .
• Descreva o comportamento que você observou após seguir as etapas e aponte qual é exatamente o problema com esse comportamento.
• Explique qual comportamento você esperava ver e por quê.
• Inclua capturas de tela e GIFs animados que mostram você seguindo as etapas descritas e demonstram claramente o problema. Se você usar o teclado enquanto segue as etapas, grave o GIF mostrado. Você pode usar essa ferramenta para gravar GIFs no macOS e Windows e essa ferramenta ou essa ferramenta no Linux.
• Se você estiver relatando que o projeto travou , inclua um relatório de travamento com um rastreamento de pilha do sistema operacional.
• Se o problema estiver relacionado ao desempenho ou à memória , inclua uma captura de perfil de CPU com seu relatório.
• Se o problema não foi desencadeado por uma ação específica , descreva o que você estava fazendo antes do problema acontecer e compartilhe mais informações usando as diretrizes abaixo.

Forneça mais contexto respondendo a estas perguntas:

• Você pode reproduzir o problema no modo de segurança?
• O problema começou a acontecer recentemente (por exemplo, após atualizar para uma nova versão) ou isso sempre foi um problema?
• Se o problema começou a acontecer recentemente, você pode reproduzir o problema em uma versão mais antiga? Qual é a versão mais recente em que o problema não acontece?
• Você pode reproduzir o problema de forma confiável? Caso contrário, forneça detalhes sobre a frequência com que o problema ocorre e sob quais condições ele normalmente ocorre.
• Se o problema estiver relacionado ao trabalho com arquivos (por exemplo, abrir e editar arquivos), o problema ocorre para todos os arquivos ou apenas para alguns? O problema ocorre apenas ao trabalhar com arquivos locais ou remotos (por exemplo, em unidades de rede), com arquivos de um tipo específico (por exemplo, apenas arquivos JavaScript ou Python), com arquivos grandes ou com linhas muito longas ou com arquivos em um codificação? Há algo mais especial sobre os arquivos que você está usando?

Inclua detalhes sobre sua configuração e ambiente:

• Qual versão do projeto você está usando?.
• Qual é o nome e a versão do SO que você está usando?
• Você está executando o projeto em uma máquina virtual? Em caso afirmativo, qual software de VM você está usando e quais sistemas operacionais e versões são usados para o host e o convidado?
• Você está usando o projeto com vários monitores? Em caso afirmativo, você pode reproduzir o problema ao usar um único monitor?
• Qual layout de teclado você está usando? Você está usando um layout dos EUA ou algum outro layout?

Sugerindo melhorias

Esta seção orienta você no envio de uma sugestão de aprimoramento para o JogaAquiApp, incluindo recursos completamente novos e pequenas melhorias nas funcionalidades existentes. Seguir essas diretrizes ajuda os mantenedores e a comunidade a entender sua sugestãomemorandoe encontre sugestões relacionadas 🔎.

Ao criar uma sugestão de aprimoramento, inclua o máximo de detalhes possível. Preencha o modelo, incluindo as etapas que você imagina que seguiria se o recurso que você está solicitando existisse.

Antes de enviar uma sugestão de aprimoramento

• Verifique se já existe um pacote que forneça esse aprimoramento.
• Faça uma pesquisa superficial para ver se o aprimoramento já foi sugerido. Se tiver, adicione um comentário ao problema existente em vez de abrir um novo.

Como faço para enviar uma sugestão de aprimoramento (boa)?

As sugestões de aprimoramento são rastreadas como problemas do GitHub. Depois crie um problema e forneça as seguintes informações:

• Use um título claro e descritivo para o problema para identificar a sugestão.
• Forneça uma descrição passo a passo do aprimoramento sugerido com o máximo de detalhes possível.
• Forneça exemplos específicos para demonstrar as etapas. Inclua snippets para copiar/colar que você usa nesses exemplos, como blocos de código Markdown .
• Descreva o comportamento atual e explique qual comportamento você esperava ver e por quê.
• Inclua capturas de tela e GIFs animados que ajudem a demonstrar as etapas ou apontem a parte do projeto à qual a sugestão está relacionada. Você pode usar essa ferramenta para gravar GIFs no macOS e Windows e essa ferramenta ou essa ferramenta no Linux.
• Explique por que esse aprimoramento seria útil para a maioria dos usuários.
• Liste alguns outros aplicativos onde esse aprimoramento existe.
• Especifique qual versão você está usando.
• Especifique o nome e a versão do SO que você está usando.

Sua primeira contribuição de código

Solicitações de pull

O processo aqui descrito tem vários objetivos:

• Manter a qualidade
• Corrigir problemas que são importantes para os usuários
• Envolva a comunidade no trabalho em direção ao melhor projeto possível
• Habilite um sistema sustentável para que os mantenedores do prjeto revisem as contribuições

Siga estas etapas para que sua contribuição seja considerada pelos mantenedores:

• Siga todas as instruções do modelo.
• Siga os guias de estilo
• Depois de enviar sua solicitação de pull, verifique se todas as verificações de status estão passando
  E se as verificações de status estiverem falhando?

  Se uma verificação de status estiver falhando e você acreditar que a falha não está relacionada à sua alteração, por favor, deixe um comentário na solicitação de pull explicando por que você acredita que a falha não está relacionada. Um mantenedor executará novamente a verificação de status para você. Se concluirmos que a falha foi um falso positivo, abriremos um problema para rastrear esse problema com nosso conjunto de verificação de status.

Embora os pré-requisitos acima devam ser atendidos antes da revisão de sua solicitação pull, os revisores podem solicitar que você conclua trabalhos de design, testes ou outras alterações adicionais antes que sua solicitação pull possa ser aceita.

Guia de estilos

Git Commit Messages

Mensagens de confirmação do Git

• Use o tempo presente ("Add feature" não "Added feature")
• Use o modo imperativo ("Mover cursor para..." e não "Move cursor para...")
• Limite a primeira linha a 72 caracteres ou menos
• Referencie problemas e pull requests livremente após a primeira linha
• Ao alterar apenas a documentação, inclua [Up Doc] no título do commit
• Considere iniciar a mensagem de confirmação com um emoji aplicável:
  • 🎨 :art: ao melhorar o formato/estrutura do código
  • 🐎 :racehorse: ao melhorar o desempenho
  • 🚱 :non-potable_water: ao conectar vazamentos de memória
  • 📝 :memo: ao escrever documentos
  • 🐧 :penguin: ao consertar algo no Linux
  • 🍎 :apple: ao consertar algo no macOS
  • 🏁 :checkered_flag: ao consertar algo no Windows
  • 🐛 :bug: ao corrigir um bug
  • 🔥 :fire: ao remover código ou arquivos
  • 💚 :green_heart: ao corrigir a compilação
  • ✅ :white_check_mark: ao adicionar testes
  • 🔒 :lock: ao lidar com segurança
  • ⬆️ :arrow_up: ao atualizar dependências
  • ⬇️ :arrow_down: ao fazer downgrade de dependências
  • 👕 :shirt: ao remover avisos
• Use Markdown

Notas Adicionais

Etiquetas de emissão e pull request

Esta seção lista os rótulos que usamos para nos ajudar a rastrear e gerenciar problemas e pull requests.

A pesquisa do GitHub facilita o uso de rótulos para encontrar grupos de problemas ou pull requests nos quais você está interessado. Para ajudá-lo a encontrar problemas e pull requests, cada rótulo é listado com links de pesquisa para localizar itens abertos. Recomendamos que você leia sobre outros filtros de pesquisa que o ajudarão a escrever consultas mais focadas.

Os rótulos são agrupados livremente por sua finalidade, mas não é necessário que cada problema tenha um rótulo de cada grupo ou que um problema não possa ter mais de um rótulo do mesmo grupo.

Por favor, abra um problema em atom/atomse você tiver sugestões para novos rótulos, e se você notar que alguns rótulos estão faltando em alguns repositórios, por favor, abra um problema nesse repositório.

Tipo de Emissão e Estado de Emissão

Rótulo	Descrição
enhancement	Solicitações de recursos..
bug	Bugs ou relatórios confirmados que são muito prováveis de serem bugs.
question	Perguntas mais do que relatórios de bugs ou solicitações de recursos (por exemplo, como faço o X).
feedback	Feedback geral mais do que relatórios de bugs ou solicitações de recursos.
help-wanted	A equipe principal gostaria da ajuda da comunidade para resolver esses problemas..
beginner	Questões menos complexas que seriam boas primeiras questões para trabalhar para usuários que desejam contribuir com o projeto.
more-information-needed	Mais informações precisam ser coletadas sobre esses problemas ou solicitações de recursos (por exemplo, etapas para reproduzir).
needs-reproduction	Erros prováveis, mas não foram reproduzidos de forma confiável.
blocked	Problemas bloqueados em outros problemas.
duplicate	Problemas que são duplicatas de outros problemas, ou seja, já foram relatados anteriormente.
wontfix	A equipe principal decidiu não corrigir esses problemas por enquanto, seja porque eles estão funcionando conforme o esperado ou por algum outro motivo.
invalid	Problemas que não são válidos (por exemplo, erros do usuário).

Categorias de Tópicos

Rótulo	Descrição
windows	Relacionado à execução no Windows.
linux	Relacionado à execução no Linux.
mac	Relacionado à execução no macOS.
documentation	Relacionado a qualquer tipo de documentação.
performance	Relacionado ao desempenho.
security	Relacionado à segurança.
ui	Relacionado ao design visual.
api	Relacionado às APIs públicas.
uncaught-exception	Problemas sobre exceções não capturadas.
crash	Relatos de completo travamento.
network	Relacionado a problemas de rede ou trabalho com arquivos remotos.
git	Relacionado à funcionalidade do Git (por exemplo, problemas com arquivos gitignore ou com a exibição do status correto do arquivo).

Rótulos de Solicitação de Pull

Rótulo	Descrição
work-in-progress	Pull requests que ainda estão sendo trabalhados, mais mudanças virão.
needs-review	Solicitações de pull que precisam de revisão de código e aprovação dos mantenedores ou da equipe principal.
under-review	Solicitações de pull sendo revisadas pelos mantenedores ou pela equipe principal
requires-changes	Solicitações pull que precisam ser atualizadas com base nos comentários de revisão e, em seguida, revisadas novamente.
needs-testing	Solicitações de pull que precisam de teste manual.