Links

Web Browsers plugins

Find out the benefits of our plugins for the code reviews

What you'll see here

  • How to install the Promyze plugin for Web browsers
  • Suggest best practices during a code review
  • Get automatic suggestions during a code review
  • Enrich the documentation of your existing best practices

Compatibility

The Web Browser plugin is compatible with GitHub, GitLab, BitBucket, AzureDevOps et Helix Swarm.
We keep efforts on maintaining compatibility with the latest versions of these tools in their Cloud version. We can provide custom compatibilities for the On-Premise version, reach us directly to get information.
Best practices & questions identification is available only on the following pages:
  • GitHub/Azure DevOps/BitBucket: On a Pull Request page from the button "Identify a Promyze practice" from the text field
  • GitHub: On a Pull Request page from the button "Identify a Promyze practice" available in the comment form.
  • Helix Swarm: On a Review page from the button "Identify a Promyze practice" available in the comment form.
On other pages, such as those listing all the commits or displaying the file contents, the plugin is not compatible.

How to download the Promyze for Web Extension

The promyze web extension is compatible with Chrome, Opera, Microsoft Edge, and Firefox.
For Chrome, Opera, and Microsoft Edge
  • Go to the Chrome Web extension store, and download the app (here)
  • Run the file to install it on your browser
  • A grayed Promyze logo should appear among your installed extensions
For Firefox :
  • Go to the Firefox Browser add-ons store, and download Promyze for Web
  • A grayed Promyze logo should appear among your installed extensions once installed

How to configure the Promyze for Web extension

Login to your Promyze instance with your account, go to the Profile -> Plugins menu and get your API Key:
Then, copy/paste it to the plugin section :
That's it! When you get the notification, you're ready to start.

Identify best practices or questions during a code review

The plugin will enrich your experience on the Pull/Merge requests page on GitLab, GitHub, Azure DevOps, and Bitbucket.

Use case #1: generate a best practice from a review comment

If you write a code review comment regarding a best practice, ask yourself if you could turn a shared knowledge for your team and store it in Promyze.
In this example below, we're on GitLab and formulate a comment about using moment framework directly in an Angular controller. Assume that in the context of this project, we should instead use a module DateFormatter designed for that purpose.
As you can see, a button Identify a Promyze practice is available on the right-bottom of the comment section. Click on it to create a best practice in Promyze.
Then, indicate whether this is a positive or negative example of a best practice, and if it's a new practice, you can provide the description and some categories. This will send the example to Promyze, and it will be discussed in the next Craft Workshop. You can also identify questions or topics to be discussed.

Get automatic suggestions during a code review

When you've validated best practices in Promyze, you can configure their automatic detection for IDE and Code reviews, using regular expressions, for instance.
Then, Promyze's rockets will display positive and negative suggestions if some best practices are detected. You can generate a comment from this suggestion; this will include both the name and the permalink of the practice.
You can also open the description of the practice to access its full documentation.

Enrich the documentation of your existing best practices

You can also document existing best practices from a suggestion by selecting the option "Identify this practice" from the suggestion menu (visible when you position the mouse cursor on the suggestion). This example will be submitted to Promyze and discussed at the next Craft Workshop.

​