jerimumhs / jerimumhs/JerimumBot

Criar arquivo `CONTRIBUTING`

Open
#19 5 comments 0 reactions 1 assignee Claimed by @josehkburger View on GitHub
enhancement Hacktoberfest
Dominant language
Python
Stars
12
Forks
8
PR merge metrics
No merged PRs in 30d

Description

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

Arquivos de referência de contributing:
- [integrati-api](https://github.com/daal-imd-dev/integraTI-api/blob/master/CONTRIBUTING.md)
- [puppet](https://github.com/thoughtbot/factory_bot_rails/blob/master/CONTRIBUTING.md)
- [factory_bot_rails](https://github.com/thoughtbot/factory_bot_rails/blob/master/CONTRIBUTING.md)
- [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)
- [Rails](https://github.com/rails/rails/blob/master/CONTRIBUTING.md)
- [mozilla workshop tutorial](https://mozillascience.github.io/working-open-workshop/contributing/)

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](https://github.com/python-telegram-bot/python-telegram-bot) para se comunicar com a [API do Telegram](https://core.telegram.org/bots/api)
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](https://github.com/jerimumhs/JerimumBot/blob/master/commands/__init__.py)
- Caso seja criada em um módulo já existente apenas adicionar o command handler utilizando a [referência da lib utilizada](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Types-Of-Handlers)

### estilização do código
copiar a seção [estilização de código do integrati-api](https://github.com/daal-imd-dev/integraTI-api/blob/master/CONTRIBUTING.md#coding-style), só que em portugues

### fluxo do fork ao PR
[Já tem o fluxo de como se abrir um PR](https://github.com/jerimumhs/JerimumBot#contributing).

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](https://github.com/jerimumhs/JerimumBot#autores)

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.