Add Contributing Guide (CONTRIBUTING.md)
Closed this issue · 0 comments
sidntrivedi012 commented
First-time Contributors
If it is the first time that you contribute to the bot, follow these steps:
- You need to have git & golang available on your machine.
- To install Git - https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- To setup golang, follow the doc here - https://golang.org/doc/install
- Write a comment in this issue thread to let other possible contributors know that you are working on this bug. For eg :
Hey all, I would like to work on this issue.
- Ping Botfather on Telegram and make your instance of OSDC-Bot bot by selecting
/newbot
from the options it provides. - Copy the
TELEGRAM_TOKEN
provided by Botfather. - Fork this repo.
- Run
git clone https://github.com/<YOUR_USERNAME>/bots.git && cd bots/telegram-bot
- If you have installed golang, run
go build .
- Wait ⏳
- Run
export TELEGRAM_TOKEN=<botfather_token>
- Now, run
./telegram-bot
. The bot would be running at the user handle provided by you. - Make changes according to the issue. Test the working of the changes.
- Commit the changes and then run
git push origin master
and then open a PR! 🎉