CONTRIBUTING.md

Contribuindo para o Receitopédia

Em primeiro lugar, obrigado por dedicar seu tempo para contribuir! ❤️

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

E se você gosta do projeto, mas não tem tempo para contribuir, tudo bem. Existem outras maneiras fáceis de apoiar o projeto e mostrar seu agradecimento, com as quais também ficaríamos muito felizes:

• Tweet sobre
• Dê uma estrela ao repositório
• Referencie esse projeto no readme do seu projeto
• Mencione o projeto para seus amigos/colegas

Índice

• Eu Tenho uma Pergunta
• Quero Contribuir
• Relatando Bugs
• Sugerindo Melhorias
• Sua Primeira Contribuição de Código

Eu Tenho uma Pergunta

Antes de fazer uma pergunta, é melhor pesquisar os Problemas existentes isso pode ajudá-lo. Caso você tenha encontrado um problema adequado e ainda precise de esclarecimentos, você pode escrever sua pergunta nos comentários. Também é aconselhável pesquisar primeiro as respostas na Internet.

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

• Adicione um Issue.
• Forneça o máximo de contexto possível sobre o que você está enfrentando.
• Forneça versões do projeto e da plataforma (nodejs, npm, etc), dependendo do que parecer relevante.

Então cuidaremos do problema o mais rápido possível.

Quero Contribuir

Aviso Legal

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

Relatando Bugs

Antes de Enviar um Relatório de Bug

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

• Certifique-se de estar usando a versão mais recente.
• Determine se o seu bug é realmente um bug e não um erro da sua parte, por exemplo, usando componentes/versões de ambiente incompatíveis (se você está procurando suporte, você pode querer verificar esta seção).
• Para ver se outros usuários experimentaram (e potencialmente já resolveram) o mesmo problema que você está tendo, verifique se ainda não existe um relatório de bug para o seu bug ou erro no bug tracker.
• Certifique-se também de pesquisar na Internet (incluindo Stack Overflow) para ver se usuários fora da comunidade GitHub discutiram o problema.
• Colete informações sobre o bug:
• SO, Plataforma e Versão (Windows, Linux, macOS, x86, ARM)
• Versão do interpretador, compilador, SDK, ambiente de execução, gerenciador de pacotes, dependendo do que parecer relevante.
• Possivelmente sua entrada e saída
• Você pode reproduzir o problema de maneira confiável? E você também pode reproduzi-lo com versões mais antigas?

Como Faço Para Enviar um Bom Relatório de Bug?

Você nunca deve relatar problemas, vulnerabilidades ou bugs relacionados à segurança, incluindo informações confidenciais, ao rastreador de problemas ou em outro lugar público. Em vez disso, bugs sensíveis devem ser enviados por e-mail para [email protected].

Usamos o issue/bug tracker do GitHub para rastrear bugs e erros. Se você tiver um problema com o projeto:

• Adicione um Issue. (Como não podemos ter certeza neste momento se é um bug ou não, pedimos que você não fale sobre um bug ainda 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 o problema por conta própria. Isso geralmente inclui seu código. Para obter bons relatórios de bugs, você deve isolar o problema e criar um caso de teste reduzido.
• Forneça as informações que você coletou na seção anterior.

Uma vez enviado:

• A equipe do projeto rotulará o problema 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. Bugs com a tag needs-repro não serão resolvidos até que sejam reproduzidos.
• Se a equipe conseguir reproduzir o problema, ele será marcado como precisa de correção, bem como possivelmente outras tags (como crítico), e o problema será deixado para ser implementado por alguém.

Sugerindo Melhorias

Esta seção orienta você no envio de sugestões de melhorias para a Receitopédia, incluindo recursos completamente novos e pequenas melhorias nas funcionalidades existentes. Seguir essas diretrizes ajudará os mantenedores e a comunidade a entender sua sugestão e encontrar sugestões relacionadas.

Antes de Enviar uma Melhoria

• Certifique-se de estar usando a versão mais recente.
• Faça uma pesquisa para ver se a melhoria já foi sugerida.
• Descubra se a sua ideia se enquadra no escopo e nos objetivos do projeto. Cabe a você apresentar argumentos fortes para convencer os desenvolvedores do projeto dos méritos desse recurso. Tenha em mente que queremos recursos que sejam úteis para a maioria dos nossos usuários e não apenas para um pequeno subconjunto. Se você está segmentando apenas uma minoria de usuários, considere escrever uma biblioteca de complementos/plugins.

Como Envio uma Boa Sugestão de Melhoria?

Sugestões de melhorias são rastreadas como GitHub issues.

• Use um título claro e descritivo para o problema para identificar a sugestão.
• Forneça uma descrição passo a passo da melhoria sugerida com o máximo de detalhes possível.
• 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 ajudam a demonstrar as etapas ou apontar a parte à qual a sugestão está relacionada. Você pode usar esta ferramenta to para gravar GIFs no macOS e Windows, e esta ferramenta ou esta ferramenta em Linux.
• Explique por que essa melhoria seria útil para a maioria dos usuários da Recetopédia. Você também pode apontar outros projetos que resolveram melhor o problema e que poderiam servir de inspiração.

Sua Primeira Contribuição de Código

📁 Configurando o repositório

1º) Fork do Repositório: Faça um Fork para levar uma cópia do repositório para a sua conta. Assim você pode fazer suas alterações sem influenciar o repositório principal.

2º) Clone o repositório:

git clone https://github.com/SuaConta/Receitopedia.git

3º) Crie sua Branch:

git checkout -b minha-nova-funcionalidade

💻 Configurando o ambiente de desenvolvimento

1º) Entre no Diretório do Projeto:

cd Receitopedia

2º) Crie um Ambiente Virtual:

python -m venv venv

3º) Ative o Ambiente Virtual:

Windows: venv\Scripts\activate
Linux/Mac: source venv/bin/activate

4º) Instale as Dependências:

pip install -r requirements.txt

5º) Aplique as Migrations (Criar o Banco de Dados):

python manage.py migrate

6º) Rode o Servidor:

python manage.py runserver

OBS:

Caso queira garantir que o código adicionado não quebre outras partes da aplicação, rode os testes existentes e, se necessário, crie novos testes. Para fazer isto:

1º) Baixe o Node na sua versão LTS:

2º) Instale as dependências:

npm ci

2º) Rode os testes com:

npx cypress run

🛰️ Submetendo suas Alterações

Abra um Pull Request com uma descrição detalhada das alterações realizadas.

1º) No repositório que você deu fork, clique em Contribute:

2º) Depois clique em Open pull request:

3º) Agora selecione o repositório que você deu fork e a branch que você fez suas alterações:

4º) Então, para criar seu PR, clique em Create pull request:

5º) Por fim....

Nós iremos avaliar a sua submissão e caso algo esteja incompatível com nosso projeto, entraremos em contato para revisarmos o seu código.

❤️ Obrigado por Contribuir!

Temos certeza de que a comunidade Open-Source têm muito a acrescentar no nosso projeto, estamos ansiosos para receber as sugestões de melhorias de vocês!

Se tiver dúvidas, sinta-se a vontade para entrar em contato com a gente: [email protected]