Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 2.13 KB

README.md

File metadata and controls

24 lines (16 loc) · 2.13 KB
Raw

CHAOSS SLACK BOT

About

This holds the code to the CHAOSS slack bot for newcomers to the project. Built with Bolt for JavaScript. For an open source community to grow, supporting newcomers and providing them with the information they need to contribute is really important. CHAOSS Slack Bot aims to provide a solution to this problem. Thanks for checking us out!

Documentation

For more information about this project, read the CHAOSS Slack Bot Docs.

Bot Functions

  • When a user joins the team, sends a message in a predefined channel asking them to introduce themselves.
  • When a user joins the team, sends an interactive message via DM to determine how they intend to contribute and provide the relevant resources.
  • When a user types “newbie” in a channel or to the bot directly, sends an interactive message showing ways you can contribute.
  • When a user types “outreachy” in a channel or to the bot directly, responds with information about Outreachy.
  • Responds when a user says "hello", "hey" or "hi".
  • Can send a DM to all users in the workspace, triggered by the message “intro-CHAOSS”.

Getting Started

If you're interested in cloning our bot for your Slack workspace, you can follow the steps in the CONTRIBUTING.md to setup, and https://slack.dev/bolt-js/deployments/heroku or https://slack.dev/bolt-js/deployments/aws-lambda to deploy.

Contributing

To contribute to CHAOSS Slack bot, please follow the guidelines found in our CONTRIBUTING.md and our Code of Conduct. We love pull requests! We welcome contributions from everyone, whether it's your 1st or your 100th. If you get stuck, please feel free to ask for help!