Contributing Guidelines
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Contributor License Agreements#
We welcome any contributors that would like to improve this repository!
When contributing to this repository, please first explain the change you wish to make via pull requests. For those getting started, GitHub has tutorials which you can visit here.
Please note that we have a Code of Conduct, please follow it in all your interactions with the project.
Get Involved#
Issues are very valuable to this project!
Ideas are a valuable source of contributions others can make.
A project is never finished because there will always be a way in which it can be improved.
The problems you find will show what the project is lacking.
With a question, you show where contributors can improve the user experience and our expertise in projects.
Thank you for creating them.
Post an issue for the API here.
Post an issue for the WEB here.
Pull Request Process#
Pull requests are a great way to get your ideas into this repository. Make sure you follow the next steps:
Read the Code of Conduct.
Ensure any install or build dependencies are removed before the end of the layer when doing a build.
Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
You may merge the Pull Request in once you have the sign-off of a developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.
Make a pull request for the API based on the template linked here.
Make a pull request for the WEB based on the template linked here.