PT

EdraDocs

Documentação em Inglês

Documentação Oficial da Área de Equipe de Robótica (EDRA) na Universidade de Brasília

Como executar?

git clone https://github.com/edra-unb-fga/EdraDocs.git

pip install mkdocs-material

mkdocs serve

em seguida, acesse http://127.0.0.1:8000/

Como contribuir?

1. Faça um Fork do Repositório: Clique no botão "Fork" no canto superior direito da página do repositório no GitHub. Isso criará uma cópia do repositório em sua conta do GitHub.

2. Clone o Repositório Forkado: Clone o repositório forkado para sua máquina local usando o comando git clone seguido pela URL do seu fork. Por exemplo:

git clone https://github.com/edra-unb-fga/EdraDocs.git

3. Crie um Novo Branch: Crie um novo branch para trabalhar em suas alterações. Use um nome descritivo para seu branch que reflita as mudanças que você está fazendo. Por exemplo:

git checkout -b feature/new-feature

4. Faça Alterações: Faça as alterações desejadas no código usando seu editor de texto ou IDE preferido.

5. Comite as Alterações: Assim que você fizer suas alterações, comite-as para seu repositório local usando o comando 'git commit'. Certifique-se de fornecer uma mensagem de commit significativa que descreva as alterações que você fez. Por exemplo:

git add .

git commit -m "Add new feature"

6. Envie as Alterações: Envie suas alterações para seu repositório forkado no GitHub usando o comando 'git push'. Por exemplo:

git push origin feature/new-feature

7. Crie um Pull Request: Vá para a página do GitHub do seu repositório forkado e clique no botão "New pull request". Compare as alterações entre seu branch e o branch principal do repositório original. Forneça um título e descrição descritivos para o seu pull request, explicando as alterações que você fez.

8. Revisão e Discussão: Após criar o pull request, outros colaboradores ou mantenedores podem revisar suas alterações e fornecer feedback. Esteja receptivo a quaisquer comentários ou sugestões feitas.

9. Aborde o Feedback (Se Necessário): Se feedback for fornecido, faça quaisquer alterações necessárias em seu código com base no feedback recebido. Comite e envie as alterações para seu branch.

10. Mescle o Pull Request: Uma vez que seu pull request tenha sido aprovado e todas as discussões tenham sido resolvidas, um mantenedor do repositório original mesclará suas alterações no branch principal.