heartthrob: overview

contribute: let's build it together

I [the author] and my team are using it in the solutions we build every single day, so expect nice fixes and small additions as it will be more and more compatible with Kendo and other browsers.

I'm more than open to have contributions to this project, so go to the GitHub page to help me make it even better!

heartthrob
heartthrob-docs

We use continuous deployment/delivery to share the latest bits to you, so we ship fixes and new features as PATCH versions 1.1.XX, if we change anything that will require you to update your code than we will update the MINOR version with a blog post on what it had changed.

how to contribute

Here is a quicky guide in how to contribute to the framework:

Clone the project from GitHub.

git clone https://github.com/vtnorton/Heartthrob.git
Use npm install to install all dependencies
Use any editor you want to make any changes inside /src
Once is finished and you want to build what you created, just run the command: gulp build, and a folder /build will appear, use that folder to implement across your system.

And now here is a quicky guide in how to contribute to the documentation:

Clone the project from GitHub.

git clone https://github.com/vtnorton/Heartthrob-docs
Use npm install to install all dependencies
Use gulp restore to restore dependencies such as font-awesome and heartthrob itself to the folder /lib
Use any editor you want to make any changes inside /src

don't code? Still want to contribute!?

Here is a few things you can do - almost in every open source project - that would help it be even better:

Found something cool on the internet that you want to be added here? Tell me!
Found a bug, please report! Will fix it ASAP - this is actually the code my team uses every single day.
This documentation can be improved somehow? Just say it to me and will do my best!
Something is missing, in the documentation, the repository, or in your life? You will be heard!
Follow me on @vt_norton and in my blog to have info about updates!

project roadmap

I'm sharing with some of my plans to move forward with heartthrob as I'm focused on:

Accessibility: I want to make it more accessible for every person in the world and make it easy for developers to create accessible websites.
Kendo UI compatibility: A lot of work to make a full compatibility with kendo is needed - including for different browsers. Also I'm focused on simplifing the kendo.heartthrob.css file.

I welcome contributions of all kinds from the community, but especially those that support the efforts above.