Criar arquivo CONTRIBUTING

[rodrigondec]

Atualmente o contributing está no readme. Deve ser criado o arquivo contributing.

Arquivos de referência de contributing:

• integrati-api
• puppet
• factory_bot_rails
• Atom
• Rails
• mozilla workshop tutorial

Deverá ser explicado:

• guide de instalação e configuração (já presente no readme)
• qual o fluxo/etapas para adicionar uma nova funcionalidade no bot (explicado em uma seção abaixo)
• estilização de código (explicado em uma seção abaixo)
• fluxo do fork ao PR (já presente no readme) (explicado em uma seção abaixo)
• mérito de contribuição (explicado em uma seção abaixo)

Fluxo para adicionar nova funcionalidade no bot

Nosso bot utiliza a wrapper lib python-telegram-bot para se comunicar com a API do Telegram
Os passos necessários para extensão de funcionalidade do bot são:

1. Decidir se será um novo módulo dentro do módulo commands ou se será criado em um já existente
2. Criar sua função que será chamada no handler
3. Configurar o handler
   • Caso seja criado um novo módulo, deverá ser criado a função de configurar_handler e importar essa nova função na lista de handlers no arquivo commands/init.py
   • Caso seja criada em um módulo já existente apenas adicionar o command handler utilizando a referência da lib utilizada

estilização do código

copiar a seção estilização de código do integrati-api, só que em portugues

fluxo do fork ao PR

Já tem o fluxo de como se abrir um PR.

Mas deverá ser explicado que:

• o pr deve ser criado a partir da branch dev e não master
• estará sujeito ao review dos mantedores do Jerimum, e que podem ser solicitadas mudanças para uma melhor qualidade
• precisará passar no CI do projeto que realiza os testes e lintagem de código para ser aceito

Mérito de contribuição

Nós temos uma seção dedicada aos contribuidores do projeto no readme

Explicar nessa seção que deverá ser incluso no readme uma contribuição adequada ao contribuidor pelo próprio dono do PR

[josehkburger]

comecei a fazer isso!

[rodrigondec]

@josehkburger incrementei a descrição para ser o mais específico possível do que é esperado.

Percebi que você já abriu o PR posteriormente. Caso não for fazer essas outras alterações solicitadas, darei merge no seu PR e adaptarei esse issue para alterar a partir das sua contribuição 😄

[josehkburger]

posso fazer sim ,mas estou com pouco tempo agora, pode ser no próximo sábado?

[rodrigondec]

Pode sim. Não tem pressa

[rodrigondec]

@josehkburger feedback?