Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contributing Guide (CONTRIBUTING.md) #8

Closed
sidntrivedi012 opened this issue Nov 18, 2019 · 0 comments · Fixed by #27
Closed

Add Contributing Guide (CONTRIBUTING.md) #8

sidntrivedi012 opened this issue Nov 18, 2019 · 0 comments · Fixed by #27
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sidntrivedi012
Copy link
Member

sidntrivedi012 commented Nov 18, 2019

First-time Contributors

If it is the first time that you contribute to the bot, follow these steps:

  1. You need to have git & golang available on your machine.
  2. 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.
  3. Ping Botfather on Telegram and make your instance of OSDC-Bot bot by selecting /newbot from the options it provides.
  4. Copy the TELEGRAM_TOKEN provided by Botfather.
  5. Fork this repo.
  6. Run git clone https://github.com/<YOUR_USERNAME>/bots.git && cd bots/telegram-bot
  7. If you have installed golang, run go build .
  8. Wait ⏳
  9. Run export TELEGRAM_TOKEN=<botfather_token>
  10. Now, run ./telegram-bot. The bot would be running at the user handle provided by you.
  11. Make changes according to the issue. Test the working of the changes.
  12. Commit the changes and then run git push origin master and then open a PR! 🎉
@sidntrivedi012 sidntrivedi012 added the good first issue Good for newcomers label Nov 20, 2019
@sidntrivedi012 sidntrivedi012 added the documentation Improvements or additions to documentation label Feb 23, 2020
@sidntrivedi012 sidntrivedi012 self-assigned this Jul 4, 2020
@sidntrivedi012 sidntrivedi012 moved this from To do to Assigned in osdc-telegram-bot Jul 4, 2020
@sidntrivedi012 sidntrivedi012 moved this from Assigned to In progress in osdc-telegram-bot Jul 4, 2020
@sidntrivedi012 sidntrivedi012 moved this from In progress to Done in osdc-telegram-bot Jul 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Development

Successfully merging a pull request may close this issue.

1 participant