Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.61 KB

Guia para contribuidores 👥

🎉 Primeiramente, muito obrigado por investir seu tempo contribuindo para nosso repositório. 🎉

1. Como começar a contribuir?

Você pode começar a contribuir de diferentes formas, não se trata apenas de implementar código. É possível contribuir relatando bugs, trazendo feedbacks, sugestões de funcionalidades ou até discussões interessantes por meio de issues.

Você pode começar procurando na página de Issues algum problema que estamos precisando de ajuda e solucioná-lo. Se a issue não está muito bem explicada, deixa um comentário perguntando que assim que possível responderemos! 😄

2. Recomendações para pull requests (PRs)

É interessante que sempre uma PR que resolva uma issue for submetida ela, na descrição da issue, possua uma indicação que sinaliza qual issue essa PR resolve/fecha. Para isso você pode fazer da seguinte maneira:

Exemplos de descrição PR que resolve uma issue de id 10

Uma breve descrição sobre essa PR.

Closes #10
Uma breve descrição sobre essa PR.

Fixes #10

Dessa forma, quando a PR for merjada a issue automaticamente será fechada.

3. Setup inicial

Para instalar a API localmente basta rodar no terminal os seguintes comandos

git clone https://github.com/Guardians-DSC/horarios-ufcg-api && cd horarios-ufcg-api
npm install
npm run dev

4. Considerações finais

Por fim, novamente: obrigado por passar um tempo com a gente! Seja contribuindo diretamente ou indiretamente para o desenvolvimento do nosso repositório e consequentemente comunidade. ⭐