Skip to content

How to submit a Power Automate sample

Jump to bottom
Hugo Bernier edited this page May 1, 2021 · 1 revision

This post will guide you through how we can best accept your sample contribution for the Power Platform sample gallery.

Why

To make your flow reusable, so that more people can benefit from it, we want to share the source code files.

Prerequisites

TODO

Download the .zip file

  • Go to ...

Unzip .zip file

Now that we have the .zip file of the exported flowe:

  • ...

Please note that you will now find all source files in that new folder. You can open the folder in a code editor of your choice, for example, Visual Studio Code.

Create the folder structure

Create a folder matching the name of your sample under the samples folder.

The sample folder should contain the following folder structure:

  • assets - where you'll put the screenshots for your sample.

    We'll also add a sample.json which will contain the metadata for the samples gallery -- but don't worry about creating it, we'll take care of it.

  • sourcecode - this is where you'll put the unpacked source code. It will most likely contain the following folder structure (which may change, depending on the version of the tool)

    TODI

NOTE: When merging the pull request, we'll pack the source and generate a .zip file. We'll place it in the solution folder.

Adding screenshots

People should be able to tell how awesome your sample is without having to download it and install it.

That's why we use screenshots.

Please provide at least one high-quality screenshot of your flow and place it in your sample folder's assets folder . If possible, use a resolution of 1920x1080 -- or an aspect ratio of 16:9. You can add as many screen shots as you'd like to help users understand your sample without having to download it and install it.

We know that creating screen shots of Power Automate flows might sound ridiculous, but it helps people preview what they're about to import. Take a shot of your entire flow, or zoom in to key areas... or do both!

If you feel fancy, you can even add an animated .gif so that people can see your sample in action (as long as you promise to pronounce it "gif", not "jif")

Adding a README.md

Each sample must have a README.md which will help people understand how cool your sample is and how to use it.

Copy the README.md template from https://github.com/pnp/powerautomate-samples/blob/main/samples/README-template.md and save it in the root of your sample folder as README.md.

Take the time to fill the template to the best of your ability. You spent your time building an awesome sample, you should definitely take a moment more to explain why it is awesome!

Make sure to include the screenshots you created in the README.md file. You should be able to insert screenshots by using the following syntax:

![Describe the image](./assets/yourfilename.png)

Submit as a sample

Well done! Now you can submit these source code files as a sample. Please, use the following steps:

If this all sounds confusing to you and you are new on GitHub - you are more than welcome to attend the Sharing Is Caring sessions, where we guide you through using GitHub and making your first PR.

Sharing Is Caring 💖

Clone this wiki locally