diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e16fe1f04b7d..e61711e356ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Electron -:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/CONTRIBUTING.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/CONTRIBUTING.md) +:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/CONTRIBUTING.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/CONTRIBUTING.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/CONTRIBUTING.md) :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: diff --git a/docs-translations/pt-BR/project/CONTRIBUTING.md b/docs-translations/pt-BR/project/CONTRIBUTING.md new file mode 100644 index 000000000000..b0496cdfdaa4 --- /dev/null +++ b/docs-translations/pt-BR/project/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# Contribuindo com Electron + +:memo: Traduções disponíveis: [Inglês](https://github.com/electron/electron/tree/master/CONTRIBUTING.md) | [Coreano](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/CONTRIBUTING.md) | [Chinês Simplificado](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/CONTRIBUTING.md) + +:+1::tada: Primeiramente, obrigado por utilizar seu tempo contribuindo! :tada::+1: + +Esse projeto segue um [código de conduta](CODE_OF_CONDUCT.md). +Participando, é esperado que o código seja seguido. Favor reportar comportamentos inaceitáveis para atom@github.com. + +O texto a seguir é um conjunto de diretrizes para a contribuição com o Electron. +São apenas diretrizes, e não regras, use o seu bom senso e sinta-se livre para sugerir modificações nesse documento em um pull request. + +## Enviando Issues + +* Você pode criar uma issue [aqui](https://github.com/electron/electron/issues/new), +porém, antes disso, por favor, leia as notas abaixo e inclua o máximo de detalhes possível em seu relato. Se puder, favor informar: + * A versão do Electron utilizada + * O sistema operacional utilizado + * Se possível, o que estava fazendo para que esse problema surgisse e o que era esperado que acontecesse +* Alguns outros meios que irão ajudar a resolver a issue: + * Imagens da 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](https://github.com/electron/electron/issues?utf8=✓&q=is%3Aissue+) + para verificar se já não existe uma issue similar já aberta + +## Enviando Pull Requests + +* Inclua imagens da tela e GIFs animados em seu pull request sempre que possível. +* Siga os [padrões de código definidos nos documentos](/docs/development/coding-style.md) para JavaScript, C++, e Python. +* Escreva a documentação em [Markdown](https://daringfireball.net/projects/markdown). + Veja o [Guia de estilo de documentação](/docs/styleguide.md). +* Use mensagens curtas e com a conjugação verbal no tempo presente. Veja em [Guia de estilo de mensagens de commit](#git-commit-messages). + +## Guias de estilo + +### General Code + +* Arquivos terminam 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 da classe e propriedades (métodos iniciam com `@`) + * Métodos de instância e propriedades +* 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: `:art:` quando aperfeiçoar o formato/estrutura do código + * :racehorse: `:racehorse:` quando aperfeiçoar a performance + * :non-potable_water: `:non-potable_water:` quando previnir vazamento de memória + * :memo: `:memo:` quando escrever documentos + * :penguin: `:penguin:` quando consertar algo no Linux + * :apple: `:apple:` quando consertar algo no macOS + * :checkered_flag: `:checkered_flag:` quando consertar algo no Windows + * :bug: `:bug:` quando corrigir um bug + * :fire: `:fire:` quando remover código ou arquivos + * :green_heart: `:green_heart:` quando consertar o build do CI + * :white_check_mark: `:white_check_mark:` quando adicionar testes + * :lock: `:lock:` quando estiver lidando com segurança + * :arrow_up: `:arrow_up:` quando atualizar dependências + * :arrow_down: `:arrow_down:` quando abaixar as dependências + * :shirt: `:shirt:` quando remover avisos do linter