Escrever documentação

[carvalholeo]

Por favor, não reporte vulnerabilidades de segurança aqui! Temos uma política de segurança com os detalhes de como proceder nesses casos, que deve ser seguido antes da liberação da brecha ao público. Consulte na raiz deste repositório.

Antes de mais nada, agradecemos por nos ajudar a melhorar esse pacote! Por favor, leia o template abaixo e responda todas as questões relevantes. Seu trabalho adicional aqui é extremamente apreciada e nos ajuda a responder tão rápido quanto possível. Para perguntas gerais, consulte as perguntas frequentes, na aba Wiki aqui no GitHub ou entre no nosso servidor no Discord (link de convite disponível no guia de contribuição, na pasta raiz do repositório). Finalmente, para evitar duplicações, por favor faça uma pesquisa nas issues abertas antes de enviar uma aqui.

Ao enviar uma issue para o repositório, você está concordando expressamente com os termos do Código de Conduta (ver arquivo CODE_OF_CONDUCT.md, na pasta raiz do repositório).

Descreva o problema que você gostaria de resolver

A documentação do pacote está bem incompleto e é preciso fazer escrever, para dar suporte aos usuários dele.

Descreva a solução ideal

Escrever a documentação na wiki do repositório, para que todos possam ler adequadamente.

Alternativas e atuais contornos/gambiarras

Não há contorno: É necessário ter uma documentação para o pacote, para evitar a criação de issues por algum bug ou pedido de feature que já pode ter sido descartado.

Contexto adicional

Guia de contribuição

Template de Pull Request