Qualquer ajuda que agregue valor ao projeto, seja na edição do código-fonte ou nas documentações, e consequentemente a vida das pessoas é muito bem-vindo, por isso decidimos torna-lo opensource.
Certifique-se de estar na pasta raiz do projeto para executar:
npm install
npm run dev - nextjs local
npm run fix - ESLint
Sugerimos que as mensagens de commit sigam o padrão do conventional commit.
Execute npm run commit para ter um painel interativo que permite seguir o padrão de commit de forma fácil.
Para saber mais, acesse esses links:
Se possível, além do endpoint crie também a documentação para o mesmo, utilizamos uma implementação básica da OpenAPI 3.0 em json. A fim de facilitar o a contribuição e evitar conflitos, modularizamos a documentação dos endpoints, assim temos arquivos mais objetivos e enxutos.
1- Acesse o diretório docs/doc;
2- Crie um arquivo json com o nome do módulo que está criando e utilize a estrutura básica da OpenAPI, recomendamos as seguintes seções:
- TAGS
- paths (obrigatório)
- components -> schemas
Caso tenha dificuldades com a criação do json, crie uma cópia do arquivo endpoint.json.example com o nome do seu endpoint, remova a extensão .example do arquivo, e edite as informações que existem nele para ajustá-lo ao seu módulo.
Para mensagens de erro utilize o schema pré-existente ErrorMessage
**Ex.: **
"404": {
"description": "Todos os serviços de CEP retornaram erro.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
Independente da contribuição a ser feita (no código-fonte e/ou na documentação), operacionalmente falando, temos 2 formas de fazermos as pull requests: localmente, via linha de comando, usando o Git em conjunto com o Github, ou online, editando diretamente os arquivos no Github e solicitando uma pull request depois, tudo graficamente.
Caso desenvolvendo localmente você precisara usar alguma versão mais recente do NodeJS para usar o NPM como gerenciador de pacotes, para instalar em seu sistema operacional basta acessar o guia de instalação caso ja tenha instalado prossiga.
Como uma das coisas mais interessantes deste projeto é justamente a promessa da Vercel de eliminar (ou pelo menos minimizar) a necessidade de programadores se preocuparem tanto em configurarem uma infraestrutura local para poderem focar mais no código, como podemos fazer em algumas IDEs online (ex. Codepen), estaremos mostrando como contribuir das 2 formas: trabalhando localmente x online.
Consiste em realizar o fork do repositório raiz, cloná-lo, realizar a alteração e solicitar o PR para o repositório raiz.
- Faça um fork desse repositório no Github
- Faça um clone do respositório fork criado:
git clone https://github.com/seuusuario/BrasilAPI.git - Crie uma branch para commitar a sua feature ou correção:
git checkout -b my-branch - Faça o commit das mudanças:
git commit -m 'feat: My new feature' - Faça o push da sua branch para o seu fork:
git push origin my-branch - Vá para Pull Requests do repositório raiz e crie um PR com o(s) seu(s) commit(s)
- Caso ainda não tenha o clone do seu fork localmente, crie-o com:
git clone https://github.com/seuusuario/BrasilAPI.git - Adicione um remote para o repositório raiz:
git remote add reporaiz https://github.com/BrasilAPI/BrasilAPI.git(reporaiz apelido para o repositório raiz da API. Você pode usar qualquer nome*) - Atualize o seu repositório local a partir do remote do repositório raiz
git fetch reporaiz - Vá para sua branch:
git checkout my-branch - Atualize sua branch com as alterações da master do repositório raiz
git pull --rebase reporaiz master - Atualize o sua branch remota
git push origin mybranch - Caso ocorra algum conflito ao fazer o
push, você pode utilizar o comandogit push origin --force-with-lease.