-
Notifications
You must be signed in to change notification settings - Fork 1
Home
This Ruby Gem is intended for Kontakt API use only. This Gem is a wrapper based on the API documentation available. http://docs.kontakt.io/rest-api/stable/resources/
Each class is named after a Kontakt API resource, and is always preceded by the module name Kontakt::CLASS.METHOD.
Use Kontakt beacons and what to help the cause? Contributing to Kontakt is not only wanted but it is needed to to make sure it meets the needs for your project. We encourage you to submit new ideas that help move the Gem forward but also follow our simple guidelines. Below is information on how to submit a pull request with newly added features.
- Get started by forking the repository to your own personal account.
- Pull the project down to your local environment and checkout the development branch.
git checkout development - Make changes, that conform to our guidelines then commit them back to
development. Please make sure your commit messages are clear and explain the changes made. - Now submit a pull request and explain the changes you are making and why.
Your pull request will be reviewed and confirmed that it meets our guidelines. Once complete your request will be merged into master pending the next version release of the Kontakt Gem.
Kontakt Gem was created to be a simple wrapper around the Kontakt API. The Gem does not include any procedural code or blocks of code that modify the response from Kontakt. When contributing to the Kontakt Gem please keep the following in mind:
- Will this be useful to others?
- Your changes should not alter the response from Kontakt's API in any way.
- Comments are not required but are very much welcome.
- Your changes should not add any new dependencies.
Before considering a change, please ask any questions you may have so that we may help you complete your project goal.