Kicking Off Hacktoberfest with ACM-VIT!
Golly Bot!
A general purpose Discord bot, written in GO!
Submitting a Pull Request
- Fork the repository by clicking the fork button on top right corner of the page
- Clone the target repository. To clone, click on the clone button and copy the https address. Then run
git clone https://github.com/ACM-VIT/golly-bot.git- Go to the cloned directory by running
cd golly-bot - Create a new branch. Use
git checkout -b mynewbranch - Make your changes to the code. Add changes to your branch by using
git add . - Commit the chanes by executing
git commit -m "short message describing changes" - Push to remote. To do this, run
git push origin mynewbranch - Create a pull request. Go to the target repository and click on the "Compare & pull request" button. Make sure your PR description mentions which issues you're solving. Wait for your request to be accepted, and you're good to go!
- Go to the cloned directory by running
Guidelines for Pull Request
- Avoid pull requests that :
- are automated or scripted
- that are plagarized from someone else's branch
- Do not spam
-
Project maintainer's decision on validity of PR is final.
For additional guidelines, refer to this website for additional information
Instructions on how to run the bot locally
-
In the cloned directory :
- Add a .env file following the .env.sample file provided and add the required secrets like token,etc.
(Instructions on how to create a Discord Bot token can be found here) - Allow the bot to have Privilaged Intents as found here
- Make sure you have go and all its dependencies installed in your system.
(Instructions can be found here) - Run the following command
go run main.goInstructions on how to run the bot in a docker container
- Add a .env file following the .env.sample file provided and add the required secrets like token,etc.
-
Build the docker image from the Dockerfile using the following command, make sure you are inside the project folder.
docker build -t <your image name> . -
Now run the application inside the container using the following command
docker run -it <your image name> -
To specify command line arguments, use
For example:docker run -it <your image name> <arguments>docker run -it <your image name> -rmcmd=false