Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 4.22 KB

Diretrizes de Contribuição para o Repositório Octopost

Bem-vindo ao Octopost! Agradecemos pelo seu interesse em contribuir para este projeto open source. Suas contribuições são fundamentais para o sucesso e a melhoria contínua deste projeto. Antes de começar, por favor, leia e siga estas diretrizes para garantir um processo de contribuição harmonioso e eficaz.

Como Contribuir

  1. Forquilhando o Repositório: Faça um fork deste repositório para sua própria conta GitHub clicando no botão "Fork".
  2. Clonando o Repositório: Clone o fork do repositório para a sua máquina local:
   git clone <https://github.com/devhatt/octopost.git>
   cd octopost

  1. Pegue uma Issue: Para instruções mais detalhadas, acesse Pegando uma Issue.

  2. Crie uma Branch: Crie uma branch a partir da develop para trabalhar nas suas alterações:

   git checkout develop
   git reset --hard upstream/develop
   git checkout -b issue-[numero-da-issue]
  1. Faça Alterações: Faça as alterações desejadas no código, documentação, ou outros recursos.
  2. Código: Siga o Style guide octopost/STYLEGUIDE.md at master · DevHatt/octopost (github.com)
  3. Testes: Certifique-se de que todas as mudanças são testadas e não introduzem erros.
  4. Commits Significativos: Faça commits significativos utilizando o conventional commits e com mensagens claras. Utilizando comando abaixo e seguindo as instruções o commit ficara no padrão utilizado no projeto.
    git commit -m "<type>: <description>"
  1. Atualize a Documentação: Se necessário, atualize a documentação relevante para refletir suas mudanças.
  2. Envie as Alterações: Envie suas alterações para o seu fork:
   git push origin issue-[numero-da-issue]
  1. Criação de Pull Request (PR): Abra um Pull Request pelo o seu fork para o repositorio do octopost na branch master, descrevendo suas alterações e fornecendo contexto sobre o que foi feito.
  2. Gerando novas Releases: Após abrir o seu PR, você deve utilizar o comando pnpm changeset para gerar um arquivo de atualização selecionando se a sua alteração é major, minor ou patch e documentar as alterações no arquivo .md gerado.
   pnpm changeset

O arquivo markdown será gerado na pasta .changeset com um nome aleatório. Cuidado para não alterar os arquivos de documentação de outras pull requests.

  1. Revisão de Código: A equipe de mantenedores do projeto irá revisar o seu PR. Esteja disposto a fazer ajustes se necessário.
  2. Merge e Fechamento: Após a revisão bem-sucedida, suas alterações serão mescladas à branch principal. Seu PR será fechado.

Gerando Builds do Electron para Windows do Linux

Se você por algum motivo precisa buildar a aplicação (gerar um .exe) a partir do linux, será necessário instalar as dependências necessárias:

sudo dpkg --add-architecture i386
sudo apt-get update
sudo apt-get install wine32

Diretrizes de Contribuição

  • Estilo de Código: Siga as convenções de estilo de código existentes no projeto.Style Guide
  • Documentação: Sempre atualize a documentação para refletir mudanças significativas.
  • Testes: Certifique-se de que suas alterações não quebram testes existentes. Se necessário, adicione novos testes.
  • Tamanho das Pull Requests: PRs menores são mais fáceis de revisar e mesclar. Tente manter o escopo de suas contribuições relativamente pequeno.
  • Mantenha a Cortesia: Seja cortês e respeitoso ao discutir e revisar o trabalho de outros contribuidores.

Reconhecimento

Agradecemos por ajudar a melhorar o Octopost! Sua dedicação à qualidade e inovação é fundamental para o sucesso contínuo deste projeto.

Se você tiver alguma dúvida ou precisar de ajuda em qualquer etapa do processo de contribuição, sinta-se à vontade para criar um problema (issue) ou entrar em contato com a equipe de mantenedores.Discord