First off, thank you for considering contributing to this project. Whether you're interested in contributing code, or contributing in some other manner, we're happy to have you on board!
This document describes how to contribute the software aspects of our project.
Following these guidelines helps to communicate that you respect the time of the team managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests and other contributions.
This repository is at the moment a very bare bones API, feature ready for an MVP.
There are several issues set at the moment in order to get things going.
The best first issues to pick are labeled with good first issue.
We expect everyone to abide by our Code of Conduct. Please read it. 🤝
Here are a couple of friendly tutorials to help you get started: http://makeapullrequest.com/ and http://www.firsttimersonly.com/
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
If you find a security vulnerability, please contact us directly at
[email protected]. For any other non security-related issues, open an issue describing the problem.
Open an issue using with the suggestion you wish to give.
Your contribution will have to be Approved by me before being merged.
We follow the conventional commits guidelines. Check here
Opening pull requests should be done with enough information and screenshots for visual changes to facilitate the reviewers job. Its MANDATORY to add a link to the issue related