slackapi/hubot-slack

Add support for `response.sendPrivate`

Open

#442 opened on Sep 29, 2017

View on GitHub
 (7 comments) (2 reactions) (0 assignees)CoffeeScript (2,339 stars) (637 forks)batch import
enhancementgood first issue

Description

  • I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've searched for any related issues and avoided creating a duplicate issue.

Description

It'd be nice to have response.sendPrivate which basically sends a direct message to the given user that initiated that response. It would be a shortcut for this mainly:

robot.messageRoom msg.message.user.name, "Hello!"

This is supported by hubot-irc, hubot-test-helper and hubot-rocketchat. Probably it would be also easier for users to figure out sending private messages quick and easy.(Check #159 and #299)

I'd like to contribute this, but I'm not really sure how to write to test it with the stubs and whatever we have in place.

Contributor guide

Tech stack
javascriptnodejs
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of HubotNode.js development environmentFamiliarity with Slack API messaging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing `response.send` method and the `robot.messageRoom` implementation in the codebase. Look at issues #159 and #299 for additional context on private messaging. Review the test files (likely in test/ directory) to understand how stubs are used for testing Slack API calls. Consider creating a simple test that verifies the private message is sent to the correct user using the existing testing patterns.