Microsoft 365 Community CLI for Microsoft 365, 29 Dec 2022

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: My experience as a first-time contributor to CLI for Microsoft 365

Description

In this 15-minute developer-focused demo, Nico De Cleyre shares his personal step-by-step experience that includes practical guidance and tips to viewers on how to contribute at many levels. Creating your local playground, creating a fork, identifying good first issues and types of issues, getting the green light to work on the issue, writing a command, creating a PR and PR approval. The chance to work with maintainers and yes, the sense of addiction you may experience in the process!

This PnP Community demo is taken from the Viva Connections & SharePoint Framework Bi-weekly sync call recorded on December 29, 2022.

Demo Presenter
• Nico De Cleyre (Ordina Belgium) | @NicoDeCleyre

Supporting materials
• Community - Discord – CLI for Microsoft 365 | https://discord.com/invite/7rfW4kg6B5
• PnP Repo - CLI for Microsoft 365 | https://pnp.github.io/cli-microsoft365/
• Repo - CLI for Microsoft 365 | https://github.com/pnp/cli-microsoft365
• Article - Getting started testing your Microsoft 365 CLI contributions - Martin Lingstuyl | https://www.blimped.nl/getting-started-testing-your-microsoft365-cli-contributions/

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/m365/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/m365/videos
• Microsoft 365 Platform Community - http://aka.ms/m365/community

A

A

Experience as a contributor, and also what is important to know when you want to contribute yourself a little bit about myself, I'm Nico de Clara and I work for ordina Belgium I started 12 years ago, as a packet developer in SharePoint 2010 shortly after spfx was introduced, I switched more to client-side developments. This was a good reason for me to contribute to the open source projects still alive, Pro Microsoft 365., uh since I already developed in test group for SharePoint framework.

A

So it was a small step to do developments for the CLI, since these are also written in typescript I'm. Also, a competent Center leads at ordina, Belgium and I also started blogging recently. So you can also find me uh on my blog.

A

How it all started for me is actually at the collect this in Belgium, where I met Milan, holomans and JC wagbart. These two peoples were already active as a maintainer on the CLI from Microsoft 365..

A

So at this event, we talked a bit on about CLI and they got me triggered so the day after collabase I contacted them to ask how I could contribute to this amazing open source project, and they were able to explain me which great enthusiasm how you can start as a contributor on the clip Microsoft 365..

A

The first thing I did was make a separate Fork. The fork is a new repository that shares good and visibility settings with our original Upstream Repository. On this Fork. You can change things to your heart's content without breaking the actual Upstream codes. It is recommended that for each issue, you do for the CLI from Microsoft 365 to create a separate pen for this. In this way, every issue we solve is protected in one separate range, but also important is is after you create. Your fork is to pull that fork locally.

A

You do this by taking the link from your GitHub Fork, including it locally with the command kit clone, followed by the URL of the org. Then, with your command prompt, you can go to the folder where you clone your fork and run the command npm install to install all the dependencies needed for the CLI from Microsoft 365..

A

Of course you need node.js version, 16 and loads package manager version 8. after you installed all the dependencies. You can run the command npm builds to build the actual codes. And finally, you run the commands. Npm link this last one is a important one. If you want to start contributing because, with npm link, you create a reference to your local projects, let's be careful, because if you had already installed the CLI from Microsoft 365 globally, you must first uninstall it before you run npm ink.

A

Once these commands have been executed, you can use your local version when using uh the M365 command in your shell. That's where do you actually start when I looked at other open source projects? I always wondered how to get started. I always thought it was too difficult to contribute that I wouldn't be able to successfully work out an issue. The CLI got. You covered there if you're, just starting out as a contributor for the CLI. It is best to look at issues labeled good. First issues.

A

These issues are a little easier to start with making the threshold to lower. When you go to the GitHub repository for the CLI, you can create an overview with only the issues with the label. Good first issues. You can do that by clicking on the good good first issue label next to an already existing issue, or you can filter it by clicking on the label, column and selecting the good first issue label.

A

Afterwards, you can scroll to the list and see which ones interest you the most. If you want to claim and issue yourself to solve, it is important that this issue is not already signed to so many you can see this if there is an icon in the column here next to the issue.

A

If you have chosen an issue that interests you, you can open it and leave a comment field in which you indicate that you would like to claim that issue and ask to assign you shortly after you leave this comment on an issue. A maintainer will assign you, and this will be done by one of the 10 maintainers, who are willing to deliver a better version of the clip Microsoft every day.

A

I had the the honor of working with these individuals for several months already and I have to say they are all very nice personalities to work with. This is one of the reasons why I chose the CLI programs of 365 Open Source Products. This open source product is a very Lively in my opinion, and you get so much appreciation for what you do.

A

So I would like to thank the maintenance for all the great work that they do every day how uh what what types of issues are there that you can can take to to solve? um Well, there are actually a great uh four types. uh The first one is the new command, uh usually proposed by one of the maintainers, um and the command is always quite straightforward, because it is always discussed with the whole Community before document is opened to be solved.

A

In addition, a new command lists the different options that belong to the commands and explains what the command has to do, and sometimes it may be that an API is already documented in the issues that you can then use to display the desired results in the output or the commands. So it's pretty easy. You know what to do. It's pretty straightforward.

A

uh Second, one is a book that has been discovered by someone, um and this person is kind enough to report this to us a greater for this. This one you can also um take if you want to contribute.

A

Thirdly, and if you can also be in announcements announcement, this means that an existing command- let's get a certain update. This can be a new option that needs to be added or an existing option that needs to be removed or replaced for the.

A

Finally, an issue can also be a script that can be interesting to create where that script uses the CLI Pro Microsoft 365 to practice a certain goal, but I must warn you when you want to contribute um Albert young Scott has already written it down on a blog post office and I have experienced it personally and I quote once the first comment was done and I got my first peer approved, it did trigger a sort of Addicting spark, so I I ended up signing on for another one immediately.

A

How do you write your first comments? um I tried to to show a sort of a timeline uh in what you have to to take in mind when you want to to write your first comments. uh Well, the first thing you need to do is go to the location where the command should come in the repository. These are good to root according to the verb and then alphabetically.

A

When you found the right location, you create two files in the folder, a DS file for the actual command and it's spec.ts file for the unit tests. The TS file often consists of one of the following parts and name get function. This retrieves the the name of the commands.

A

Next, a brief description of the comment itself and next to that, you can also have a possible the default properties that must be shown on outputs text, comma, separate value or markdown documentation is used in an addition. You see it on the Second Step here, uh they're also for possible functions in the Constructor itself. You have the init options function. This function defines the option, the options associated with the command itself.

A

You have the init telementary function, that's a function that collects the measures. How many times an optional option is used. The mandatory option should not be added to this. Then the init validators function, where you can indicate which options should be validated. Think of an ID that can be a good awareness, therefore be checked whether it's available and the last possible option is in option sets. It defines the options.

A

That's like the name says, for example, if you want either an option ID or the option, title is used as an option for for document, but not a boat. At the same time, keep in mind that these four functions does not always have to be used in the in the ecosector.

A

Eventually, after that, in we are still in the the dot TS file, you have the function of the command itself. Right write the logic of the commands. This function has two variables each time, a logarithm variable that you can use to log data during or after executing the commands and a variable Parts, which contains, among other things, options of the command together with their values. Next to the dot. Ts value also have the spec.ts file for the unit testing.

A

It is important that these tests must always ensure 100 good coverage, since the CLI from Microsoft 365 is certified, satisfied with nothing less writing. This test was new to me and created a learning curve, um but I have to say that I have benefits that a lot from marketing links, tools block where he explains in a clear way how to best, write these tests and what each comment does in such a test, so check out this blog. If you want to write, you need this for the CLI last but not least, is the documentation.

A

It is. That is also very important, because this documentation is used to have a clear documentation database on the CLI for Microsoft 365 website. The documentation is housed in the docs folder of the repository also arranged according to their verb and then alphabetically. The command documentation consists of an dots, MD file. It is also important that this documentation is included in the table of contents, and you do this by adding the pads to the mpdocs.y ml file.

A

um That is the information that that is really important when, when you want to make your first contribution once you've done with creating your your command or enhancement or or whatever and you've checked everything, uh you can commit and publish your bench to your fork. In GitHub, after that, you could do your GitHub fork and create a new pull request by creating a pull request. You indicate that you want to merge certain pieces of code with the main code of the CLI.

A

Of course you cannot do this directly, but via pull request, you allow the maintainers to do this for you in the title of the pull request, you give a short description, for example, ads comment or enhances commands, followed by the commands, its name itself, enclosed with, with the hashtag followed by the four digits of the issue. You do the same in the description field, with slightly longer explanation added to it any remarks. If there are any and in the description too, you have to write a hashtag with the four digits of the issue.

A

So in this way you allow the pr the to be linked to the issue. Once the pull request has been created, you wait until one of the maintainers feels called to check your PR when checking your PR. They will check whether or not there are improvements or errors in its. um If this is the case, they will request changes to your PR and convert your pull request in draft modes. You can then solve this. uh These changes Mark if it is as resolved and when you're done you can mark your PR as ready for review.

A

Once the maintainers find that your pull requests is complete, they will approve it and merge it with the main code of the CLI shortly afterwards.

A

The nice thing is that you are not only appreciated for what you do for the CLI for Microsoft 365 you're also involved, and it's a nice one, because one of my first commands I wrote was the Power Platform card gets, which will display the data of an Adaptive card from the Power Platform.

A

Even though an Adaptive card is part of the part, but from it uses the dynamic 365 platform and the API to get an Adaptive card is therefore also part of the Dynamics 365 and because I had done something about Dynamics 365 I was only docked by albertian Scott out of nowhere in another issue with the question.

A

If I also knew something about data for stable rows, because they also use the Dynamics 365 platform and to be honest, I had no experience with these apis, but I was interested in figuring it out and I did, and by the fact that I researched this I have created all the insights and learned a lot about these parts of Microsoft 365, and that's what I like to figure things out to learn and to step out of my comfort zone, because this way I think you can become a better developer.

A

So thank you for listening. If you are interested in contributing for the CLI for Microsoft, 365 do not hesitate to contact us by the way. We also have a very nice Discord, where you can join. Ask questions and follower changes on this Discord there's also a very cool guy named Parker bot, who tries to thank each contributor in an original way when you, when your pull request, is merged. Excellent. Thank you, Nikon that one a really really cool stuff awesome awesome.