Coding Starter Projects

Projetos de codificação-Starter

Um repositório básico para compartilhar seus projetos iniciantes com outras pessoas e ajudá -los a crescer também!

Primeiro, obrigado por reservar um tempo para contribuir!

Todos os tipos de contribuições são incentivados e valorizados. Veja o índice para obter diferentes maneiras de ajudar e detalhes sobre como este projeto lida com eles. Certifique -se de ler a seção relevante antes de fazer sua contribuição. Isso tornará muito mais fácil para nós, mantenedores, e suavizará a experiência de todos os envolvidos. A comunidade aguarda ansiosamente suas contribuições.

E se você gosta do projeto, mas simplesmente não tem tempo para contribuir, tudo bem. Existem outras maneiras fáceis de apoiar o projeto e mostrar sua apreciação, sobre a qual também ficaríamos muito felizes:

• Estrela o projeto
• Tweet sobre isso
• Consulte este projeto no readme do seu projeto
• Mencione o projeto em encontros locais e diga aos seus amigos/colegas

Índice

• Código de Conduta
• Eu tenho uma pergunta
• Eu quero contribuir
• Relatórios de bugs
• Sugerindo aprimoramentos

Código de Conduta

Este projeto e todos os participantes são governados pelo Código de Conduta Contribuindo. Ao participar, você deve defender este código. Por favor, relate um comportamento inaceitável para <>.

Eu tenho uma pergunta

Se você deseja fazer uma pergunta, assumimos que você leu a documentação disponível.

Antes de fazer uma pergunta, é melhor procurar problemas existentes que possam ajudá -lo. Caso você tenha encontrado um problema adequado e ainda precisa de esclarecimentos, pode escrever sua pergunta nesta questão. Também é aconselhável pesquisar primeiro a Internet por respostas.

Se você ainda sentir a necessidade de fazer uma pergunta e precisar de esclarecimentos, recomendamos o seguinte:

• Abra um problema.
• Forneça o máximo de contexto possível sobre o que você está encontrando.
• Forneça versões de projeto e plataforma (NodeJS, NPM, etc), dependendo do que parece relevante.

Em seguida, cuidaremos da questão o mais rápido possível.

Eu quero contribuir

Aviso legal

Ao contribuir para este projeto, você deve concordar que é autor de 100% do conteúdo, que possui os direitos necessários para o conteúdo e que o conteúdo que você contribui pode ser fornecido sob a licença do projeto.

Relatórios de bugs

Antes de enviar um relatório de bug

Um bom relatório de bug não deve deixar outras pessoas que precisam persegui -lo para obter mais informações. Portanto, solicitamos que você investigue cuidadosamente, colete informações e descreva o problema em detalhes em seu relatório. Preencha as etapas a seguir com antecedência para nos ajudar a corrigir qualquer bug potencial o mais rápido possível.

• Verifique se você está usando a versão mais recente.
• Determine se o seu bug é realmente um bug e não um erro no seu lado, por exemplo, usando componentes/versões de ambiente incompatíveis (verifique se você está lendo a documentação. Se você estiver procurando por suporte, consulte esta seção).
• Para ver se outros usuários experimentaram (e potencialmente já resolvidos) o mesmo problema que você está tendo, verifique se ainda não existe um relatório de bugs existente para o seu bug ou erro no rastreador de bugs.
• Também certifique -se de pesquisar na Internet (incluindo o Stack Overflow) para verificar se os usuários fora da comunidade do GitHub discutiram o problema.
• Colete informações sobre o bug:
• Stack Trace (Traceback)
• OS, plataforma e versão (Windows, Linux, MacOS, x86, braço)
• Versão do intérprete, compilador, SDK, ambiente de tempo de execução, gerente de pacotes, dependendo do que parece relevante.
• Possivelmente sua entrada e saída
• Você pode reproduzir com segurança o problema? E você também pode reproduzi -lo com versões mais antigas?

Como envio um bom relatório de bug?

Você nunca deve relatar questões, vulnerabilidades ou bugs relacionados à segurança, incluindo informações confidenciais ao rastreador de problemas ou em outros lugares do público. Em vez disso, os bugs sensíveis devem ser enviados por e -mail para <>.

Utilizamos problemas do GitHub para rastrear erros e erros. Se você tiver um problema com o projeto:

• Abra um problema. (Como não podemos ter certeza neste momento, seja um bug ou não, pedimos que você não fale sobre um bug e não rotule o problema.)
• Explique o comportamento que você esperaria e o comportamento real.
• Forneça o máximo de contexto possível e descreva as etapas de reprodução que outra pessoa pode seguir para recriar a questão por conta própria. Isso geralmente inclui seu código. Para bons relatórios de bugs, você deve isolar o problema e criar um caso de teste reduzido.
• Forneça as informações coletadas na seção anterior.

Uma vez arquivado:

• A equipe do projeto rotulará a questão de acordo.
• Um membro da equipe tentará reproduzir o problema com as etapas fornecidas. Se não houver etapas de reprodução ou nenhuma maneira óbvia de reproduzir o problema, a equipe solicitará essas etapas e marcará o problema como needs-repro . Os bugs com a tag needs-repro não serão abordados até que sejam reproduzidos.
• Se a equipe for capaz de reproduzir o problema, será marcado por needs-fix , bem como possivelmente outras tags (como critical ), e o problema será deixado para ser implementado por alguém.

Sugerindo aprimoramentos

Esta seção o orienta ao enviar uma sugestão de aprimoramento para contribuir . Seguir essas diretrizes ajudará os mantenedores e a comunidade a entender sua sugestão e encontrar sugestões relacionadas.

Antes de enviar um aprimoramento

• Verifique se você está usando a versão mais recente.
• Leia a documentação com cuidado e descubra se a funcionalidade já está coberta, talvez por uma configuração individual.
• Realize uma pesquisa para ver se o aprimoramento já foi sugerido. Se houver, adicione um comentário ao problema existente em vez de abrir um novo.
• Descubra se sua ideia se encaixa no escopo e nos objetivos do projeto. Cabe a você defender um forte argumento para convencer os desenvolvedores do projeto dos méritos desse recurso. Lembre -se de que queremos recursos que serão úteis para a maioria de nossos usuários e não apenas um pequeno subconjunto. Se você estiver apenas segmentando uma minoria de usuários, considere escrever uma biblioteca de complementos/plug-in.

Como envio uma boa sugestão de aprimoramento?

As sugestões de aprimoramento são rastreadas como problemas do GitHub.

• Use um título claro e descritivo para que o problema identifique a sugestão.
• Forneça uma descrição passo a passo do aprimoramento sugerido no maior número possível de detalhes.
• Descreva o comportamento atual e explique qual comportamento você esperava ver e por quê. Neste ponto, você também pode dizer quais alternativas não funcionam para você.
• Você pode incluir capturas de tela e GIFs animados que ajudem a demonstrar as etapas ou apontar a parte à qual a sugestão está relacionada. Você pode usar esta ferramenta para gravar GIFs no macOS e Windows, e esta ferramenta ou esta ferramenta no Linux.
• Explique por que esse aprimoramento seria útil para os usuários mais contribuintes. Você também pode querer apontar os outros projetos que o resolveram melhor e que poderiam servir como inspiração.