RunKit notebooks are a great way to file bugs on GitHub. Since RunKit automatically packages your code with its entire environment in a Docker container, anyone can clone your bug and start investigating it live in seconds, without any setup or installation. Best of all, the bug will be completely reproducible and avoid the dreaded “works on my machine”. Today we’re excited to be improving this experience even further with a completely revamped UI for filing and analyzing issues on Node.js:
Our initial focus was to make stack traces in Node.js significantly easier to interpret and understand. RunKit interacts directly with the V8 data to provide a much more detailed view than any other implementation we’ve seen. One example is how RunKit dramatically streamlines the experience of navigating the stack trace by inlining the offending code right in the frame, as well as providing documentation for many of Node’s built-in functions:
But we also focused on a lot of little details, like swapping in canonical names for functions whenever we can in order to avoid the more confusing inferred V8 names that sometimes show up. Another thing you’ll notice is that we now show you the version of the package you’re using immediately as you require it. This makes it so that all the dependency information in your notebook is immediately digestable with a glance. It’s a lot of fun when coding, but even more useful when looking at someone’s else’s code.
Together, all these features result in a bug report that surfaces all the pertinent background for a bug with no extra work for the user. Instead of relying on templates to remind people to include all this, RunKit just knows it by default. That’s because with RunKit you’re not just filing a bug, you’re filing an entire container, enabling the coolest feature of all: the ability to run it.
How To Get Started
The easiest way to get started using RunKit to file bugs is to Sign Up and then head on over to a package’s corresponding RunKit page (such as https://runkit.com/npm/lodash). You can then paste the generated link on the package’s bug tracker. If you’re a package maintainer and want a more customized experience, you can use our API to embed RunKit right on your page.