Skip to content
This repository has been archived by the owner on May 28, 2023. It is now read-only.

Latest commit

 

History

History
51 lines (34 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.47 KB

Contribuindo para o Laguinho

Contribuições sempre serão bem vindas, sejam pequenas ou grandes!

Código de Conduta

Adotamos um código de conduta que esperamos que todos sigam a participar do projeto. Leia para entender que ações toleramos e quais não antes de abrir qualquer issue ou pull request.

Estrutura do projeto

A estrutura de arquivos do projeto se assemelha ao exemplo abaixo:

/laguinho
    /models
        __init__.py
        metadata.py
        error_messages.py
        [ futuros outros arquivos de modelagem ]
    /routes
        __init__.py
        datasets.py
        [ futuros outros arquivos para rotas ]
    /errors
        __init__.py
        handlers.py
        [ futuros outros arquivos para gerenciamento de erros ]
    __init__.py

Organização de Issues

As issues são um espaço aberto para requisitar criação ou correção de funcionalidades da API. Também pode ser usada como um espaço de discussão sobre assuntos gerais do projeto.

Veja sobre nossa organização de Issues!

Propondo uma mudança

Caso deseje propor uma mudança, primeiro verifique se já não existe uma Issue sobre o que você deseja. Se não, abra uma Issue relacionada ao seu problema e espere a comunidade te responder.

Primeira contribuição

Caso tenha se interessado pela nossa comunidade, deseja contribuir para o nosso projeto, mas não sabe por onde começar, dê uma olhada em issues com a tag good first issue que serão um bom ponto de partida. Também vale a pena olhar sobre Issues relacionadas a tecnologias que você já tem uma certa familiaridade.

Se você decide fazer alguma mudança, e não existe uma Issue sobre, crie uma nova informando o que será feito e manifeste que você irá querer fazer. Caso exista a Issue, verifique nos comentários se já não existe alguém trabalhando nisso, e comente que você deseja fazer.

Não tenha medo de pedir por orientação ou ajuda, mas, acima de tudo, seja destemido e respeitoso. Você também pode participar de discussões para ajudar a comunidade a realizar boas escolhas!

Enviando uma Pull Request

Está pronto para submeter uma Pull Request? Primeiro dê uma olhada nesse guia!