HassBot is the chat assistant for the Home Assistant chatrooms on Gitter.
The goal of HassBot is to help productivity in providing support to other users of Home Assistant.
- HassBot should have a personality and sense of humor as part of being productive. Please do not submit entertainment scripts with no practical use for productivity.
- HassBot should not flood the chat rooms, keep responses as short as possible or respond with a private message for longer responses.
- HassBot should not annoy, insult, or harrass users. This includes scripting that returns false positives and posting when it shouldn't.
Feel free to contribute to the evolution of HassBot.
- Fork the HassBot repository at https://github.com/home-assistant/hassbot.
- Get a local copy:
git clone https://github.com/[your_username]/hassbot.git - Add our branch for rebasing:
git remote add upstream https://github.com/home-assistant/hassbot.git - Create a new working branch:
git checkout -b [new_branch] - Make your changes.
- Stage your changes:
git add . - Commit your changes:
git commit -m "[Add a brief description of changes.]" - Upload changes to your fork:
git push origin [branch_name] - Compare and Submit Pull Request to the dev branch on GitHub.com.
- Create a separate Gitter user for testing.
- Join the new user to a chat with your main account.
- Get your Gitter Personal Access Token for the test user at https://developer.gitter.im
- Run
$ HUBOT_GITTER2_TOKEN=[Test_user_personal_access_token] ./bin/hubot -a gitter2 --name [test-user-name]