Video tutorials

[rabwill]

Hey folks,
Looks like this project gets a lot of attention from developers around the world to participate and contribute which is simply great 👌
The guides in my opinion are spot on but there have been quite a few requests I get looking for some extra guidance on things, like

• Manage multiple node version
• What is a bash script and how to get started
• how to write a simple test

And they are looking for some videos to have a look at.
Any plans for video tutorials on setting up for a successful contribution to CLI?

Cheers,
Rabia

[waldekmastykarz]

Hey @rabwill, all these would be a great addition and we could definitely use some help with them. Would you be willing to help us?

[rabwill]

I am definitely keen to help :) but I have also never done video tutorials, I should probably ask David (Warner) to help me set things up for success.

[waldekmastykarz]

Have you seen the yo teams videos we recorded recently at PnP? It could really be as simple as that. Pick one topic, hit record. Don't worry about the production (adding intro/outro/title slide). We can handle that. You could also sync with @appieschot who is working on a couple of other short videos for CLI.

[rabwill]

Perfect ! Game on 🚀

[siddharth-vaghasia]

@rabwill ..... I was thinking of the same and found this thread..., I got 3 requests in the last 2 weeks about advice on how to contribute to this library...

Below are things I can list down which would be a good video tutorial(just out of my experience).

1. Setting up a local office 365 development environment (the guide is spot on and I was able to follow without any issue)
2. How to test your changes locally by running the command. (the guide is spot on and I was able to follow without any issue)
3. What does Mocha test mean and how to write test cases and what all scenarios to be considered?
4. How to test local coverage/coveralls details, identify the cause of reducing coverage...

3rd and 4th points are which is not easy to understand and would definitely need some extra guidance... I am still struggling on 4th :)

I can also extend helping hand if anything is required.

[waldekmastykarz]

1, 2 and 4 make perfect sense. 3 seems very generic. If it's just related to Mocha, then I'd defer to using the existing Mocha docs rather than copying what they have.

Our original intention was to cover some of this information in our contributors docs at https://github.com/pnp/office365-cli/blob/master/docs/guides/index.md. If that's not the case, then we should see where we should improve.

[siddharth-vaghasia]

Sure @waldekmastykarz... For point#3 if we will have a video tutorial that explains and walkthrough mocha tests which are already written for 1 or 2 commands and comparing the actual command and its output... just a thought and sharing on what can help to a first-time contributor ...

[waldekmastykarz]

If there is existing material for mocha, how about we pointed to that and spend our effort on things that are specific to CLI and which only we can do. Would that work? 🙂

[arjunumenon]

Would be super helpful if we can bring out the videos / tutorial for Point#3 and Point#4. Even pointing to the patterns which we are following, like Waldek mentioned also would help us figure out how to do that.

Totally seconding @siddharth-vaghasia 's comment about 1 and 2. They are spot on and pretty straight forward.

[PrasadKasireddy]

Also, what is best way to submit PR while working on multiple PRs - one of common issue with segregate commit to respective PRs (#1706 (comment)).
For instance, while working on multiple PRs, the old PR commits are still add into new PRs until merge the old PRs if you still used master branch.

[dips365]

@PrasadKasireddy That's good point, Any advice or document that provides the steps to work with multiple PRs with single branch.
Recently i face a issue while working with multiple commands but my old PR is still is in review. So, when i commit anything and push to git repository, existing PR is directly impacted and starts coverage steps to check.

[waldekmastykarz]

Hey guys, have you read our contributors docs at https://github.com/pnp/office365-cli/blob/master/docs/guides/index.md? They should clarify a couple of the things you mentioned.