Como Colaborar com a Documentação¶

Bem-vindo ao guia de contribuição para a nossa documentação! Se você está interessado em melhorar a documentação do projeto, siga os passos abaixo.

Templates para seguir uma organização¶

Contribuindo com o Projeto¶

1. Faça um Fork do Projeto¶

Para começar, você precisa ter uma cópia do projeto na sua conta do GitHub. Visite a página do projeto e clique em Fork no canto superior direito.

2. Clone o Repositório¶

Após o fork, clone o repositório para a sua máquina local usando:

git clone git@github.com:byndcloud/quoti-docs.git

3. Crie uma Branch¶

Antes de fazer suas alterações, crie uma branch para manter o processo organizado:

git checkout -b nome-da-sua-branch

4. Faça suas Alterações¶

Com o arquivo em Markdown aberto, faça as alterações ou adições que você acha que vão melhorar a documentação.

5. Envie um Pull Request¶

Depois de concluir suas alterações, faça commit e push para sua branch. Então, no GitHub, vá para o seu fork e inicie um Pull Request para a branch principal do projeto original.

6. Aguarde a Aprovação¶

Sua contribuição será revisada e, se tudo estiver de acordo, será mesclada com a documentação principal.

Tutorial de Markdown¶

Markdown é uma linguagem de marcação leve que você pode usar para adicionar elementos de formatação a documentos de texto simples. Aqui está um rápido tutorial:

Básico¶

Títulos: Use # para criar títulos. # para h1, ## para h2, e assim por diante até ###### para h6.
Parágrafos: Escreva um texto normalmente. Deixe uma linha em branco entre linhas de texto para criar parágrafos.
Negrito: Use **texto** ou __texto__ para negrito.
Itálico: Use *texto* ou _texto_ para itálico.
Listas: Use - ou * para listas não ordenadas e 1., 2., etc., para listas ordenadas.

Links e Imagens¶

Links: Use [texto do link](URL) para criar um link.
Imagens: Use ![alt text](url-da-imagem) para inserir imagens.

Códigos e Citações¶

Código Inline: Use crases `codigo` para código inline.
Blocos de Código: Use três crases ou indente com 4 espaços para blocos de código.
Citações: Use > para citações.

Tabelas¶

Crie tabelas usando traços - e pipes | para separar colunas e cabeçalhos.

| Cabeçalho 1 | Cabeçalho 2 |
| ----------- | ----------- |
| Item 1      | Item 2      |

Avançado¶

Código com Syntax Highlighting: Use três crases seguidas pelo nome da linguagem.
Listas Aninhadas: Indente listas abaixo de outras listas para criá-las.
Tarefas: Use - [ ] e - [x] para criar listas de tarefas não marcadas e marcadas, respectivamente.

Explore e pratique essas marcações para melhorar a qualidade da documentação que você contribuirá. E lembre-se, sua colaboração é valiosa para o projeto! ```

Este guia fornece as instruções básicas para qualquer pessoa começar a colaborar com a documentação do projeto, bem como um tutorial simplificado de Markdown para aqueles que são novos na linguagem ou precisam de um lembrete rápido sobre a formatação.