Skip to content

Commit

Permalink
docs: enriquecendo página de contribuição
Browse files Browse the repository at this point in the history
  • Loading branch information
ThiagoPanini committed Feb 29, 2024
1 parent 9466d0b commit 5228e49
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions docs/contribuindo/contribuindo.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
# Contribuindo com o pynvest

:octicons-alert-16:
Página em construção
Curtiu o projeto e encontrou alguma oportunidade de contribuir com ele de alguma forma? Vai fundo! Sendo uma iniciativa *open source*, qualquer um interessado em deixar sua contribuição será extremamente bem vindo.

???+ question "Para contribuir eu preciso necessariamente escrever linhas de código?"
Não necessariamente! Uma contribuição pode ser desde um módulo adicional na biblioteca, como também o apontamento de alguma *issue* ou *feature request*. Sua interação é extremamente válida para manter a ideia viva!


O pacote surgiu de forma despretensiosa e com o simples objetivo de facilitar a gestão financeira pessoal do criador. Ao longo do tempo, percebeu-se que tais funcionalidades poderiam facilmnente ajudar outras pessoas dentro do mesmo escopo e propósito. Assim, a biblioteca tomou forma e, hoje, o resultado atual se mostra dentro de tudo o que está consolidado nesta documentação.


## Como Contribuir?

Bom, em primeiro lugar, é importante que os potenciais contribuidores tenham a ciência completa sobre a biblioteca *pynvest* e o seu propósito. Dessa forma, as ideias de contribuição poderão ser moldadas e adaptadas para encaixar no escopo da biblioteca.

Dito isso, os potenciais contribuidores podem acessar o repositório oficial da biblioteca e iniciar seus respectivos desenvolvimentos.

- :fontawesome-brands-github: [Repositório com código fonte](https://github.com/ThiagoPanini/pynvest)
- :fontawesome-brands-python: [Página da biblioteca no PyPI](https://pypi.org/project/pynvest/)

## Issues

Abrir uma *issue* também é uma forma de contribuir com o projeto. Atualmente, existem alguns modelos específicos de *issues* que podem ser utilizados pelos usuários para fornecer insumos específicos sobre o projeto:

- 🐞 Report de *bugs* da biblioteca
- 📄 Aprimorando de documentações já existentes ou inclusão de novas páginas
- 🚀 Requisição de novas funcionalidades para o projeto
- 😵‍💫 Pedido de ajuda para tarefas no geral
- 🤔 Questões ou dúvidas sobre o projeto

0 comments on commit 5228e49

Please sign in to comment.