Skip to content

Commit

Permalink
added D4D commands and welcome message
Browse files Browse the repository at this point in the history
  • Loading branch information
Dstar4 committed Mar 21, 2019
1 parent 6c2aeef commit 8418dde
Show file tree
Hide file tree
Showing 13 changed files with 1,478 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# http://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.DS_Store*
.hubot_history
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: bin/hubot -a slack
82 changes: 81 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,81 @@
# slackbot
# D4D Hubot

## Outline

---

- Project Overview
- Getting Started
- Feedback
- Getting Started

## Project Overview

---

**Project Lead:** @dstar4

### What is the goal of this project?

The Data for Democracy Hubot was created to help create a more organized and efficient onboarding process for new members. Along with assisting onboarding the bot will have several commands to provide useful and current information. The majority of the information the bot will provide will be links to existing D4D repositories. This is done intentionally to help direct more people towards the D4D Github organization and so the information can be updated on the github instead of having to update the bot with new information.

### What can this bot do?

**Hubot will assist with onboarding new members**

Every new member to join #general will get a message from Hubot asking them to review the Code of Conduct as well as suggesting some steps to get started with Data for Democracy.

**Commands**

Hubot will have several commands to provide members with useful information. These commands can be accessed by opening a message to Hubot and typing 'help'.

- help - returns all bot commands
- !docs - Returns Important D4D information
- https://github.com/Data4Democracy/read-this-first
- !conduct - Returns the D4D Code of Conduct
- https://github.com/Data4Democracy/read-this-first/blob/master/Code-of-Conduct.md
- !new project - Returns links relevant to creating a new project.
- https://github.com/Data4Democracy/read-this-first/blob/master/new-project-template.md
- https://github.com/Data4Democracy/read-this-first/blob/master/lead-role-description.md
- https://github.com/Data4Democracy/read-this-first/blob/master/example_lead_routine.md
- !idea - Returns links relevant to a new project idea.
- https://github.com/Data4Democracy/project-ideas
- !feedback - Returns instructions for leaving feedback about the bot. This could include desired new features or any features that are not working correctly.

## Feedback

We would like this project to be as open as possible. If you have a suggestion for the bot or have noticed a bug please create a github issue and send a message to @dstarling on slack. If you would like to create a function for the bot or modify an existing function please feel free to submit a pull request.

## Getting Started

This is a chat bot built on the Hubot framework. It was initially generated by generator-hubot.

**Running hubot Locally:**
Once you have forked and cloned this repository.
You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

You can start hubot locally by running:

```
% bin/hubot
```

You'll see some start up output and a prompt:

```
Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
hubot>
```

You can find a full hubot setup guide here: https://hubot.github.com/docs/

To run hubot in a slack workspace you will need to setup a new slack app and generate a unique token.
You can find instructions to do this here: https://slack.dev/hubot-slack/

### Contributing

**Contributing step guide**

### Dependencies

**List Dependencies**
8 changes: 8 additions & 0 deletions bin/hubot
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/sh

set -e

npm install
export PATH="node_modules/.bin:node_modules/hubot/node_modules/.bin:$PATH"

exec node_modules/.bin/hubot --name "Data" "$@"
7 changes: 7 additions & 0 deletions bin/hubot.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@echo off

call npm install
SETLOCAL
SET PATH=node_modules\.bin;node_modules\hubot\node_modules\.bin;%PATH%

node_modules\.bin\hubot.cmd --name "Data" %*
12 changes: 12 additions & 0 deletions external-scripts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[
"hubot-diagnostics",
"hubot-help",
"hubot-heroku-keepalive",
"hubot-google-images",
"hubot-google-translate",
"hubot-pugme",
"hubot-maps",
"hubot-redis-brain",
"hubot-rules",
"hubot-shipit"
]
1 change: 1 addition & 0 deletions hubot-scripts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
Loading

0 comments on commit 8418dde

Please sign in to comment.