InstantLink is intended to be a public project that anyone can participate in. If you would like to add support for new functions, fix a bug, do performance optimization etc. please read this guide.
Fork, then clone the repo:
git clone git@github.com:your-username/instant-link.git
Install it:
npm install
Make your changes. And build it. Test it by serving up the example under /example
npm build
If you are filing a bug report, make sure that you test it with the development build, not the minimized build.
Push to your fork and submit a pull request.
At this point you're waiting on us to accept the request. We like to at least comment on pull requests within a week (and, typically, within 24 hours). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write a good commit message
- Well written documentation
If you have any problems, please don't hesitate to contact us via github.