Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): tradução da documentação da aplicação (pt-BR) #41

Open
hmartiins opened this issue Jun 22, 2021 · 0 comments
Open

feat(docs): tradução da documentação da aplicação (pt-BR) #41

hmartiins opened this issue Jun 22, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@hmartiins
Copy link
Member

Documentando a aplicação

A equipe da PeruibeTec continua documentando a aplicação. O nosso objetivo é ter toda a aplicação documentada, esclarecendo assim quaisquer dúvidas sobre a arquitetura, rotas ou funcionalidades da aplicação. Primeiramente, documentaremos o aplicativo em inglês, pois é o idioma principal do repositório (conforme descrito em CONTRIBUTING.MD), caso você queira saber mais sobre a documentação da aplicação em inglês, acesse a issue #39, e depois traduziremos esta documentação para o português (pt-BR), pois é nossa língua nativa.

Como posso contribuir para a documentação?

Você pode contribuir de diversas formas para a documentação do PeruibeTec, você pode:

  1. Corrigir erros ortográficos;
  2. Apontar possíveis melhorias para a documentação;
  3. Documentar algo novo, que você considere ser importante para ser documentado;

Antes de realizar qualquer uma dessas etapas, crie uma issue ou seja responsável por uma issue já criada (se você tiver dúvidas sobre como criar uma issue, consulte CONTRIBUTING.md)

Traduzindo um arquivo

Se você não é do time PeruibeTec, e deseja traduzir algo, siga esses passos:

  1. Crie um Fork desse repositório no seu usuário;
  2. Crie uma branch em seu Fork chamada username-ptBR-traducao-arquivo (exemplo: hmartiins-ptBR-traducao-express-types.md)
  3. De um push para seu Fork com os arquivos criados
  4. Crie uma nova Pull Request nesse repositório, com o título de feat(docs): <arquivo traduzido> file translation
  5. Após criar a Pull Request, mencione @hmartiins, @PocketLocked and @devLeSilverio, para realizar a review
  6. Se tudo estiver ok, parabéns, sua documentação agora faz parte do PeruibeTec 🎉

Caso tenha alguma dúvida, comente nessa Issue, a sua dúvida pode ser a dúvida de qualquer pessoa também...

@hmartiins hmartiins added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant