Documentation

[rodrigondec]

Create the official README and instructions for our project.

We must describe:

• What and why was this project created (motivation)
  • Link to Ticket Splitting Buyer documentation
• Development setup (with possible ways of running the projec: python and docker)
  • how to setup python virtual env
  • how to setup docker + docker-compose
  • how to create your bot on telegram with BotFather
  • how to run the project
• Specify this project as Open Source and ask for help maintaining/developing
  • Contribute guide (how to contribute)

References

• https://github.com/jerimumhs/JerimumBot?target=https://github.com
• https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
• https://github.com/daal-imd-dev/integraTI-api/blob/master/CONTRIBUTING.md?target=https://github.com
• https://github.com/thoughtbot/factory_bot_rails/blob/master/CONTRIBUTING.md?target=https://github.com
• https://github.com/atom/atom?target=https://github.com
• https://github.com/rails/rails?target=https://github.com
• https://github.com/matheusd/dcr-split-ticket-matcher?target=https://github.com

[som23ya]

Is this issue open? Can i work on it?

[rodrigondec]

Yes. It's open and your help is welcomed 😁

I'll describe exactly what would be god to be done

[som23ya]

Hey, I am really new to open source and contributions, so i would be eagerly waiting for guidance to the project. I have intermediate python knowledge though :D Somya Upadhyay

…

On Fri, Nov 29, 2019, 1:44 AM Rodrigo Castro ***@***.***> wrote: Yes. It's open and your help is welcomed 😁 I'll describe exactly what would be god to be done — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#6>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKNA2EWQH4ZI2NT5XG2CCCLQWARDPANCNFSM4JSMDH3A?target=https://github.com> .

[rodrigondec]

@som23ya
Ok, I created another issue for documentation #9. Feel free if you prefer to do the other issue.

Are you familiar with the basic of open source contributing? (forks, pull requests, reviews)

[som23ya]

Yes i do have basic knowledge of github and commands. I will look up the other issue too. Somya Upadhyay

…

On Fri, Nov 29, 2019, 1:56 AM Rodrigo Castro ***@***.***> wrote: @som23ya <https://github.com/som23ya?target=https://github.com> Ok, I created another issue for documentation #9 <#9>. Feel free if you prefer to do the other issue. Are you familiar with the basic of open source contributing? (forks, pull requests, reviews) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKNA2EWX26ZJPDMRRKFT33TQWASN7ANCNFSM4JSMDH3A?target=https://github.com> .

[rodrigondec]

feel free to do just some part of the issue too. I believe the most important now is do Development setup