ldooks/dragon-bot
ldooks/dragon-bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adding some PR templates and a contribution guideline

Browse Source
This commit is contained in:
Luke Robles 2018-06-21 12:10:36 -07:00
parent a911efbd73
commit ed7ba5319b
3 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.gitlab/merge_request_templates/merge_request.md Normal file
View File

@ -0,0 +1,8 @@
### New Merge Request
- What?
* `briefly describe the issue this is fixing`
- How?
* `briefly describe what this PR is doing to remedy the issue`
- Why?
* `is there an open issue associated with this PR? if so, reference it with #56 (or whatever the issue number is)`

6
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,6 @@
### Contribution guidelines ###
* Make your changes
* Test the bot by running `test-dragon-bot.sh` and interacting with the bot in the `#dragon-bot-test` channel
* This will lint your python as well
* Create your pull request
* bonus points if you include screenshots, terminal output, or even videos of the features on the PR

27
README.md
View File

@ -20,32 +20,19 @@ This project was used mainly to teach members of the discord channel about softw
* Here we track issues and collaborate on the bot * Here we track issues and collaborate on the bot
### How do I get set up? ### ## How do I get set up? ###
* Install docker ### Installing docker
* linux
* as root (`sudo -s`) * as root (`sudo -s`)
* `curl -Ls get.docker.com | bash` * `curl -Ls get.docker.com | bash`
* Give yourself docker permissions `sudo usermod -aG docker <your username>` * Give yourself docker permissions `sudo usermod -aG docker <your username>`
* Or if you are using OS X * OS X
* `curl -L get.macapps.link/en/docker | bash` * `curl -L get.macapps.link/en/docker | bash`
* open /Applicaitons/Docker.app
* Complete the setup steps * Complete the setup steps
* Windows
### Testing your changes ### * See [This](https://medium.com/@sebagomez/installing-the-docker-client-on-ubuntus-windows-subsystem-for-linux-612b392a44c4) guide
* Build the testing container by running
* `./test-dragon-bot.sh`
* The dragon-bot-test bot will connect to the server.
* If you want to test what the bot is seeing when you type commands, add LOTS of of print statements to dragon-bot.py
* you will see the output in the terminal. This is useful for debugging
* pipeline [here](https://gitlab.com/ldooks/dragon-bot/pipelines)
### Contribution guidelines ###
* Make your changes
* Test the bot by running `test-dragon-bot.sh` and interacting with the bot in the #test_channel
* Create your pull request
* bonus points if you include screenshots, terminal output, or even videos of the features on the PR
### Who do I talk to? ### ### Who do I talk to? ###
* Bad dragon in discord * Bad dragon in discord