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

Moving the Official Wechaty Examples over #21

Closed
suntong opened this issue Jul 4, 2018 · 16 comments
Closed

Moving the Official Wechaty Examples over #21

suntong opened this issue Jul 4, 2018 · 16 comments
Assignees

Comments

@suntong
Copy link
Contributor

suntong commented Jul 4, 2018

Is it a good idea to move the Official Wechaty Examples from https://github.com/Chatie/wechaty/tree/master/examples to here?

Those example, cannot be used out of the box, due to the relative-path importing.
Moving them over here will eliminate one more unnecessary step for new developers/users to try out Wechaty.

At the very least, please move the ding-dong-bot over, and give example in README how to start the ding-dong typescript bot.

And please move hot-import-bot example over as well, as I wasn't even able to make it run -- wechaty/wechaty#1222

Thx

@suntong
Copy link
Contributor Author

suntong commented Jul 4, 2018

I think all of the following bots belong here, thus hope at least these are moved over.

  • ding-dong-bot
  • media-file-bot
  • hot-import-bot
  • gist-bot

@huan
Copy link
Member

huan commented Jul 4, 2018

Thanks for the suggestion and I feels it's a very good idea.

The only thing we need to take care is to keep this starter repo from to be complicated: it has to be the simplest because we must try our best to make the studying curve smooth for the beginners.

I'll keep this open and think about it later.

@suntong
Copy link
Contributor Author

suntong commented Jul 4, 2018

Good point to keep this starter repo from to be complicated. In that case, I'm thinking at least these samples should be moved over:

  • ding-dong-bot
  • media-file-bot
  • hot-import-bot

Because, after all, we need to do something in the end right? Having as many working-out-of-the-box examples as possible will definitely be an asset, that's why I was including gist-bot previously because for people that aim big projects, that'll be a better start.

Any way, still my 2c,
your call.

huan added a commit that referenced this issue Jul 16, 2018
@huan
Copy link
Member

huan commented Jul 16, 2018

We had just added those examples because, after some time of thinking, I feel it's necessary to add them as vanilla javascript example.

In order to keep things simple, we just put the examples in the subdirectory of the examples/ directory, and it can just run out-of-the-box.

Thank you for purposing this, and keep trying to use our hot-import-bot! :)

huan added a commit that referenced this issue Jul 16, 2018
huan added a commit that referenced this issue Jul 16, 2018
@huan
Copy link
Member

huan commented Jul 16, 2018

@suntong Now we have all the Wechaty examples in this repository, you can have a look on it at https://github.com/Chatie/wechaty-getting-started/tree/master/examples/

There would be one more job left: the README should be better written. Would you like to write a README for the Examples List Directory? It would be fantastic if you could because you will have a better view than me.

huan added a commit to wechaty/wechaty that referenced this issue Jul 16, 2018
@suntong
Copy link
Contributor Author

suntong commented Jul 16, 2018

I'm honored, however I'll be very busy for the next two weeks. Will try find sometime after that.
Let me leave this open to remind me...

@huan
Copy link
Member

huan commented Jul 17, 2018

Thank you very much for accepting my invitation!

Please take your time and no rush, and looking forward to your documentation PR!

@huan
Copy link
Member

huan commented Aug 9, 2018

ping @suntong

Did you get time recently?

@suntong
Copy link
Contributor Author

suntong commented Aug 13, 2018

Sorry, still need another week or two to get some free time. :(

@huan
Copy link
Member

huan commented Aug 13, 2018

No problem, just want to know your schedule.

Let's get iback to it again on September.

@huan
Copy link
Member

huan commented Aug 26, 2018

@suntong Hello, I hope you are doing well!

Could you get free time now?

@suntong
Copy link
Contributor Author

suntong commented Aug 27, 2018

Yeah, finally got some free time this weekend, however, my new cheap Android phone is acting up and not letting me to install the Google Service and App Store. I've spent the whole weekend fighting it, but up till now it is stilling winning.

Anyway, will try to see if I can find some free time next weekend ...

@huan
Copy link
Member

huan commented Aug 27, 2018

Okay. And good luck to you for your next fighting with your Android! 😆

@suntong
Copy link
Contributor Author

suntong commented Sep 2, 2018

I've done the English part (see #54) and have left out the Chinese part, as I'm really not good at typing Chinese.

Please review. As for the Chinese, I don't think word-for-word translating my description is necessary, as the writer might have a better view than me, :)

Moreover, I've also left out the third-party directory as I don't know how you would handle it. I recommend merely mentioning the third-party directory in README would be enough, as they each should have a proper README.

cheers

@huan
Copy link
Member

huan commented Sep 4, 2018

Thank you very much for your awesome pull request!

Merged.

@huan
Copy link
Member

huan commented Jul 4, 2019

Close this issue because all tasks had been done perfectly.

@huan huan closed this as completed Jul 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants