Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
246 lines (165 loc) · 10.2 KB

CONTRIBUTING.md

File metadata and controls

246 lines (165 loc) · 10.2 KB
Raw

Contribuindo

Obrigado por dedicar o seu tempo para contribuir! 🙇‍♀️🙇‍♂️ Toda ajuda é bem-vinda!

💌 Quer contribuir, mas não se sente à vontade?

Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente?

Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜

Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para cumbucadev@gmail.com e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar.

O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨

Primeira Contribuição

Como fazer a sua primeira contribuição:

1. Crie uma Conta no GitHub

Certifique-se de ter uma conta no GitHub e de estar com a sessão iniciada.

Caso não tenha uma conta, siga os passos de como criar de uma conta pessoal no GitHub.

2. Encontre uma Issue para Trabalhar

Visite a página de issues do cinemaempoa e encontre uma issue com a qual você gostaria de trabalhar e que ainda não tenha sido atribuída a ninguém.

Deixe um comentário na issue dizendo que tem interesse em trabalhar. Em seguida, alguém do time vai atribuir a issue a você.

Sinta-se à vontade para fazer qualquer pergunta na página da issue antes ou durante o processo de desenvolvimento.

Ao começar a contribuir para o projeto, é recomendável que você pegue uma issue por vez. Isso ajuda a garantir que outras pessoas também tenham a oportunidade de colaborar e evita que recursos fiquem inativos por muito tempo.

3. Instale o Git

Certifique-se de ter o git instalado, seguindo os passos do tutorial de instalação do git.

4. Faça um Fork do Projeto

Faça um fork do repositório cinemaempoa.

5. Clone o Seu Fork

Clone o seu fork localmente.

6. Crie um Novo Branch

Entre na pasta do brutils:

$ cd cinemaempoa
>

E crie uma nova branch com o nome da issue em que você irá trabalhar através do comando:

$ git checkout -b <issue_number>
>

Exemplo:

$ git checkout -b 386
Switched to a new branch '386'
>

7. Execute o cinemaempoa Localmente

Para executar o projeto, leia a seção rodando o projeto do arquivo README.md do projeto.

Nele está explicado o passo a passo para realizar a instalação e execução do projeto, através de instalação local ou via Docker

8. Faça as Suas Alterações

Após ter feito a instalação e executado corretamente, você poderá implementar as suas alterações no código.

Às vezes podem existir instruções/ideias de como você pode implementar a solução diretamente na descrição da issue. Leia atentamente tudo que está escrito na issue para garantir que suas modificações resolvem tudo que está sendo solicitado.

9. Faça o Commit e Envie as Suas Alterações

Formate o seu código executando utilizando o pre-commit:

  • o pre-commit pode automatizar a formatação do código quando você rodar um git commit.

Para utilizá-lo, instale com:

pre-commit install

Faça o commit das alterações:

$ git commit -m "<commit_message>"
...

Exemplo:

$ git commit -m 'Adicionando mais info aos arquivos de contribuição'
[386 173b7e6] Adicionando mais info aos arquivos de contribuição
 2 files changed, 144 insertions(+), 34 deletions(-)

Envie o seu commit para o GitHub:

$ git push --set-upstream origin <issue_number>
...

Exemplo:

$ git push --set-upstream origin 386
Running pre-push hook checks
All checks passed!
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 10 threads
Compressing objects: 100% (4/4), done.
Writing objects: 100% (4/4), 2.36 KiB | 2.36 MiB/s, done.
Total 4 (delta 3), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (3/3), completed with 3 local objects.
remote:
remote: Create a pull request for '386' on GitHub by visiting:
remote:      https://github.com/cumbucadev/cinemaempoa/pull/new/386
remote:
To github.com:cumbucadev/cinemaempoa.git
 * [new branch]      386 -> 386

Faça as alterações e commits necessários e envie-os quando estiverem prontos.

10. Crie um PR no GitHub

Antes de abrir um Pull Request, valide e formate o código conforme descrito na seção Instalando o projeto usando Docker, utilizando também da ferramenta pre-commit

Crie um PR no GitHub para enviar suas alterações para revisão. Para garantir que seu Pull Request (PR) seja claro, eficaz e revisado rapidamente, siga estas boas práticas:

Escreva um Título Descritivo para o PR

  • Use títulos claros e específicos para descrever o propósito das suas alterações. Um bom título ajuda às pessoas mantenedoras a entender a intenção do PR rapidamente e melhora a rastreabilidade do projeto.
  • Exemplo: Em vez de “Nova funcionalidade”, use “Adiciona a funcionalidade pesquisar_salas_proximas para listar as salas de cinema próximas da pessoa usuária.”
  • Benefícios:
    • Títulos claros facilitam a priorização e o entendimento pelos revisores.
    • Melhoram a organização e a busca no projeto.

Forneça uma Descrição Detalhada do PR

  • Inclua uma descrição completa no seu PR para explicar:
    • O que foi feito (ex.: adicionou uma nova função, corrigiu um bug).
    • Por que foi feito (ex.: para resolver uma issue específica ou melhorar o desempenho).
    • Quais problemas foram resolvidos ou melhorias aplicadas (ex.: referencie a issue ou descreva a melhoria).
  • Exemplo: Este PR adiciona o utilitário converter_sessao_em_lista para converter as sessões de cinema em listas. Resolve a issue #474, melhorando a iteração das sessões de cinema. A função inclui validação de entrada e testes atualizados.
  • Benefícios:
  • Descrições detalhadas agilizam o processo de revisão ao fornecer contexto.
  • Ajudam futuros mantenedores a entender o propósito e o histórico do código.

Vincule o PR à Issue Relacionada

  • Referencie a issue que seu PR resolve usando palavras-chave como Closes #474 ou Fixes #474 na descrição do PR. Isso fecha a issue automaticamente quando o PR for mesclado.
  • Exemplo: Closes #474
  • Benefícios:
  • Vincular issues mantém o repositório organizado e garante o rastreamento de tarefas.
  • Automatiza o fechamento de issues, reduzindo trabalho manual para mantenedores.
  • Para mais detalhes, consulte a documentação do GitHub sobre fechamento automático de issues.

11. Atualizar a Sua Branch se Necessário

Certifique-se de que sua branch esteja atualizado com o main

12. Contribuição feita!

Pronto! Após você ter seguido as orientações deste documento, você acabou contribuindo para um projeto Open Source e te agradecemos por todo tempo e esforço dedicado!

Tem mais ideias ou sugestões de melhorias?

  1. Abra uma issue

    OU

  2. Nos envie uma mensagem por e-mail (cumbucadev@gmail.com) ou pelas nossas redes: Instagram / LinkedIn


Sinta-se sempre à vontade para continuar contribuindo 💌

- Equipe Cinemaempoa e CumbucaDev