Contribuindo com Electron

📝 Traduções disponíveis: Inglês | Coreano | Chinês Simplificado

👍🎉 Primeiramente, obrigado por utilizar seu tempo contribuindo! 🎉👍

Esse projeto segue um código de conduta. Ao participar, é esperado que o código seja seguido. Favor reportar comportamentos inaceitáveis para electron@github.com.

O texto a seguir é um conjunto de diretrizes para a contribuir com o Electron. Estas são apenas diretrizes e não regras, use o seu bom senso e sinta-se livre para propor alterações nesse documento em um pull request.

Reportando Issues

Você pode criar uma issue aqui, mas antes disso, por favor, leia as notas abaixo e inclua o máximo de detalhes possíveis em seu relato. Se puder, favor informar:
- A versão do Electron utilizada
- O sistema operacional utilizado
- Se possível, o que estava fazendo quando o problema ocorreu e o que era esperado que acontecesse
Alguns outros meios que irão ajudar a resolver a issue:
- Capturas de tela e GIFs animados
- Saída de erro que aparece no terminal, dev tools ou algum em algum alerta
- Faça uma pesquisa rápida para verificar se já não existe uma issue similar já aberta

Submetendo Pull Requests

Inclua capturas de tela e GIFs animados em seu pull request sempre que possível.
Siga os padrões de código definidos nos documentos para JavaScript, C++, e Python.
Escreva a documentação em Markdown. Veja o Guia de estilo de documentação.
Use mensagens curtas e com a conjugação verbal no tempo presente. Veja em Guia de estilo de mensagens de commit.

Guias de estilo

Código Geral

Terminar arquivos com uma nova linha.
A organização deve estar na seguinte ordem:
- Módulos embutidos do Node (como o path)
- Módulos embutidos do Electron (como ipc, app)
- Módulos locais (usando caminhos relativos)
Defina as propriedades da classe na seguinte ordem:
- Métodos e propriedades da classe (métodos iniciam com @)
- Métodos e propriedades de instância
Evite o uso de códigos dependentes da plataforma:
- Use path.join() para concatenar nomes de arquivos.
- Use os.tmpdir() ao invés de /tmp quando precisar referenciar o diretório temporário.
Use um simples return para retornar explícitamente o fim de uma função.
- Não usar return null, return undefined, null, ou undefined

Mensagens de Commit do Git

Use o tempo presente ("Adicionando função" não "Adicionada função")
Use o modo imperativo ("Mova o cursor para..." não "O cursor deve ser movido...")
Limite a primeira linha para 72 caracteres ou menos
Referencie issues e pull requests livremente
Quando alterar somente a documentação. inclua [ci skip] na descrição do commit
Considerando iniciar a mensagem do commit com um emoji:
- 🎨 :art: quando aperfeiçoar o formato/estrutura do código
- 🐎 :racehorse: quando aperfeiçoar a performance
- 🚱 :non-potable_water: quando previnir vazamento de memória
- 📝 :memo: quando escrever documentação
- 🐧 :penguin: quando corrigir algo no Linux
- 🍎 :apple: quando corrigir algo no OSX
- 🏁 :checkered_flag: quando corrigir algo no Windows
- 🐛 :bug: quando corrigir um bug
- 🔥 :fire: quando remover código ou arquivos
- 💚 :green_heart: quando corrigir o build do CI
- ✅ :white_check_mark: quando adicionar testes
- 🔒 :lock: quando estiver lidando com segurança
- ⬆️ :arrow_up: quando atualizar dependências
- ⬇️ :arrow_down: quando abaixar as dependências
- 👕 :shirt: quando remover avisos do linter

4.2 KiB Raw Blame History