Merge pull request #83 from Rickecr/update/docs

Atualizando dados sobre a documentação #37

CONTRIBUTING.md

@@ -112,11 +112,53 @@ Para os testes nós optamos por usar o `pytest`, visto que é bem aceito pela co
     ~~~
 
 
-E agora é só criar sua classe de teste, caso a classe de teste para a classe que você fez a funcionalidade ainda não exista.
+E agora é só criar sua classe de teste, caso ela não exista para a classe que você fez a funcionalidade.
 Você deve criar os testes para a(s) sua(s) funcionalidade(s), tentando pegar todos os casos extremos, sabemos que é dificil também.
 
+E suas alterações devem garantir que os outros testes continuem funcionando, a não ser que você tenha achado um problema no
+código, algo que não deveria acontecer.
+
 E após realizar os testes, você está pronto para realizar sua [PR](https://github.com/Rickecr/PyGraph/blob/master/CONTRIBUTING.md#realizando-uma-pull-request---pr) e ser feliz com o mundo OpenSource.
 
+
+### Entrando nos padrões:
+
+Nós optamos por seguir o padrão da [PEP 8](https://www.python.org/dev/peps/pep-0008/). Portanto, seu código não deve violar nenhuma regra da mesma. Para verificar isso, usamos o `pycodestyle`.
+
+#### Pycodestyle:
+
+Nós usamos o pipenv para gerenciar nossas dependências.
+
+- Primeiro você precisa instalar o pipenv:
+
+    ~~~bash
+    $ pip install --user pipenv
+    ~~~
+
+- Para instalar as dependências usadas no projeto:
+
+    ~~~bash
+    $ pipenv install
+    ~~~
+
+- Para testar se tudo funcionou bem, digite no terminal:
+
+    ~~~bash
+    $ pipenv run pytest --version
+    ~~~
+
+- Se a saída for a mesma que abaixo(podendo mudar a versão) esta tudo correto:
+
+    ~~~bash
+    $ This is pytest version 5.2.0, imported from /home/rickecr/.local/lib/python3.6/site-packages/pytest.py
+    ~~~
+
+- Para executar o pycodestyle:
+
+    ~~~bash
+    pycodestyle .
+    ~~~
+
 ## Realizando uma Pull Request - PR
 
 Na página do seu fork irá aparecer uma mensagem em amarelo solicitando que você faça uma Pull Request para o repositório original. Ao clicar irá abrir uma página para você preencher as informações sobre sua PR.

README.md

@@ -26,7 +26,8 @@
 
 - PRs são aceitas!
 - Se você pensou em uma feature legal ou descobriu algum bug e não tem tempo para codificar, abra uma issue.
-- Nós seguimos as diretrizes do [PEP 8](https://www.python.org/dev/peps/pep-0008/). Portanto, antes de fazer uma PR verifique se seu código obedece os padrões do PEP 8.
+- Nós seguimos as diretrizes do [PEP 8](https://www.python.org/dev/peps/pep-0008/). Portanto, antes de fazer uma PR verifique se seu código obedece os padrões do PEP 8(pycodestyle).
+- Execute os testes antes de enviar sua PR(pytest).
 - Sempre documente seu código.
 - Para mais detalhes sobre como contribuir, acesse o [CONTRIBUTING.md](CONTRIBUTING.md).
 

docs/README.md

@@ -3,14 +3,18 @@
 
 ## Qual objetivo da biblioteca ?
 
-Visto que não possuem muitas bibliotecas desse ramo escritas em Python. O objetivo da biblioteca é permitir a fácil utilização dos algoritmos de Grafos.
+O objetivo é a criação de uma biblioteca que facilite o uso de conceitos de Teoria dos Grafos.
+
+Já que não possuem muitas bibliotecas desse ramo escritas em Python. O objetivo da biblioteca é permitir a fácil utilização dos algoritmos de Grafos.
+
+Também tem objetivo de fazer com que estudantes contribuam e apliquem seus conhecimentos de Teoria dos Grafos.
 
 ## Quem somos ?
 
 Somos alunos da UFCG.
 
-- Rich Elton
-- Matheus Santana
-- José Davi
-- Eduardo Pereira
-- Yuri Souza
+- [Rich Elton](https://github.com/Rickecr)
+- [Matheus Santana](https://github.com/mathsantana)
+- [José Davi](https://github.com/JoseDavi)
+- [Eduardo Pereira](https://github.com/Eduardoccufcg)
+- [Yuri Souza](https://github.com/yuri-s-s)

docs/index.md

@@ -5,20 +5,20 @@
 - [Vértices](#vértices)
 
 ## Grafos:
-> Os grafos implementados na biblioteca.
+Os grafos implementados na biblioteca.
 
 - [Graph](graphs/graph.md) - Grafo base.
 - [SimpleGraph](graphs/simple_graph.md) - Grafo Simples.
 - [CompleteGraph](graphs/complete_graph.md) - Grafo Completo.
 - [WeightedGraph](graphs/weighted_graph.md) - Grafo Ponderado.
 
 ## Arestas:
-> As arestas implementadas na biblioteca para serem usadas pelos grafos.
+As arestas implementadas na biblioteca para serem usadas pelos grafos.
 
 - [SimpleEdge](edges/simple_edge.md) - Aresta Simples
 - [WeightedEdge](edges/weighted_edge.md) - Aresta Ponderada
 
 ## Vértices:
-> Os vértices implementados na bibliotecas para serem utilizados pelas arestas e grafos.
+Os vértices implementados na bibliotecas para serem utilizados pelas arestas e grafos.
 
 - [SimpleVertex](vertices/simple_vertex.md) - Vértice Simples