Contributing with this project

I'm glad that you are interested in contribute with us! If you want to help us, you may check the open issues and do one of the following:

If you are developing an application using this api

Create a pull request with the addition of your application in README.md! We would love to check your awesome jobs!

We use the commit guidelines from Angular to share a pattern between all ours commits. We use Commitizen to automate it.

We are developing this API inside medeiro.tech community and we invite you to join and share your ideas with us!

To send new Pull Requests, do the following steps:

Create a fork of this project
Make your changes and add tests.
If you implemented a new endpoint, add its reference in README.md and update our swagger.
Ensure that all tests passed.
Ensure that your code go through our lint process: yarn lint