Documenting the application

The PeruibeTec team is continuing to document its application. Our aim is to have the entire application documented, thus clarifying any doubts about the application's architecture, routes or features. First we will document the application in English, as it is the main language of the repository (as described in CONTRIBUTING.MD) and after that, we will translate this documentation to Portuguese (pt-br), as it is our native language

How to contribute to the creation of the documentation?

You can contribute in different ways to the PeruibeTec server documentation, you can:

1. Correct spelling mistakes;
2. Point out possible improvements to the documentation;
3. Documenting something you deem important to be documented

Before performing any of these steps, create an Issue, or be responsible for an Issue already created (if you have questions on how to create an issue, see CONTRIBUTING.md)

Creating my documentation file

If you're not from PeruibeTec's core, and want to create a file documenting something, follow these steps:

0. Create an issue with a documentation label
1. Within this Issue, say what your idea of ​​documentation is
2. Wait for a moderator to approve your idea (the moderator can disapprove or suggest changes to the idea)
3. After approval, create a Fork of this repository for your user
4. Create a branch on your fork called yourusername-en-documentation-yourideia (example: hmartiins-en-documentation-architeture-for-project)
5. push to your fork, with the created file
6. Create a new Pull Request in this repository, and the title should be feat(docs): English documentation <your documentation>
7. Within Pull Request, check @hmartiins, @PocketLocked and @devLeSilverio, so we can review
8. If everything is OK, congratulations your documentation is now part of PeruibeTec 🎉

If you still have any doubt, comment it here in this Issue, your doubt may be the doubt of other people too..

Purpose

We need to change the API responses to the new LGPD (General Data Protection Law), ideally the responses return only the user id, and nothing that can identify him, such as name, email, photo...

You must return the id via the JWT token sub, so if the unique identifier changes we won't need to change all the keys in the token.

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:

0. Crie um Fork desse repositório no seu usuário;
1. Crie uma branch em seu Fork chamada username-ptBR-traducao-arquivo (exemplo: hmartiins-ptBR-traducao-express-types.md)
2. De um push para seu Fork com os arquivos criados
3. Crie uma nova Pull Request nesse repositório, com o título de feat(docs): <arquivo traduzido> file translation
4. Após criar a Pull Request, mencione @hmartiins, @PocketLocked and @devLeSilverio, para realizar a review
5. 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...