Slack Developer Kit for Node.js
Go to GitHub

Frequently Asked Questions

What even is this?

Slack Developer Kit for Node.js is a wrapper around commonly accessed parts of the Slack Platform. It provides basic mechanisms for using the Slack Web API, Incoming Webhooks, and the RTM API. And it works with Node.js. So, if you are building a Slack app in Node.js, you will probably find Slack Developer Kit for Node.js just what you needed.

On the other hand, Slack Developer Kit for Node.js is not a high-level bot development framework (although you could certainly use it as the basis for a bot!) like BotKit or Slapp. If you’re serious about developing kick-ass bots with Node.js, have a look at those modules instead.

OMG I found a bug!

Well, poop. Take a deep breath, and then let us know by opening an issue. If you’re feeling particularly ambitious, why not submit a bugfix?.

Hey, there’s a feature missing!

There’s always something more that could be added! You can open an issue to start a discussion around the feature, that’s a good start. If you’re feeling particularly ambitious, why not write the feature yourself, and submit a PR!. We love feedback and we love help and we don’t bite. Much.

I’d like to contribute…but how?

What an excellent question. First of all, please have a look at our general contributing guidelines. We’ll wait for you here.

All done? Great! While we’re super excited to incorporate your new feature into Slack Developer Kit for Node.js, there are a couple of things we want to make sure you’ve given thought to.

  • Please write unit tests for your new code. But don’t just aim to increase the test coverage, rather, we expect you to have written thoughtful tests that ensure your new feature will continue to work as expected, and to help future contributors to ensure they don’t break it!
  • Please document your new feature. Think about concrete use cases for your feature, and add a section to the appropriate document (probably “basic_usage.md”), including a complete sample program that demonstrates your feature.

Including these two items with your pull request will totally make our day—and, more importantly, your future users’ days!

On that note…

How do I compile the documentation?

If you are editing one of the many markdown files in the docs folder, there is nothing you need to do: GitHub will do the right thing automatically.

If you have added JSDocs to the code, you will need to run

npm run make-docs

to generate the reference documentation from the embedded JSDocs.