diff options
author | 2018-10-05 22:27:19 +0100 | |
---|---|---|
committer | 2018-10-05 22:27:19 +0100 | |
commit | a90769721f6e83153a4bbea4ab0bb15a81183bb1 (patch) | |
tree | 4ef314e1777e2cb782a72dcb7cbe27b790584771 /README.md | |
parent | Merge remote-tracking branch 'origin/master' (diff) |
added commands and motivation sections to README
also added docstring to templete.py for repository command
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 19 insertions, 1 deletions
@@ -1,4 +1,22 @@ # hacktoberbot -A community project for Hacktoberfest 2018. A Discord bot primarily designed to help teach Python learners from the PythonDiscord community how to contribute to open source. +A community project for [Hacktoberfest 2018](https://hacktoberfest.digitalocean.com). A Discord bot primarily designed to help teach Python learners from the PythonDiscord community how to contribute to open source. You can find our community by going to https://discord.gg/python + +## Motivations +We know it can be difficult to get into the whole open source thing at first. To help out, we've decided to start a little community project during hacktober that you can all choose to contribute to if you're finding the event a little overwhelming, or if you're new to this whole thing and just want someone to hold your hand at first. + +by *Lemon* + +## Commands + +### repository +Alias: project +A command to send the hacktoberbot github project + +### git +Alias: github +A command that sends a getting started with Git page + +### git.commit +Sends a sample first commit |