This project is used by the Power BI Engineering team to build visualizations that ship with Power BI products and services. By contributing, you can have your code ship within a Microsoft product. For example, if you contribute a new visual, we could ship it to all Power BI users. We’re looking forward to helping you get your contributions into the repository.
Since it’s our production code, we have code guidelines that must be met for changes to be accepted. The contribution guidelines are listed below. Let us know if you have questions on the guidelines, we’re here to help. One thing we encourage is that you fork the repo if you’re planning to do substantial work. This lets you move forward at the pace you want and when it comes time to submit a pull request, we’ll be able to refer to the fully working set of end to end code.
Before you start working on a feature, substantial code contribution, or interface change, please discuss it with the team to ensure it is an appropriate addition to the core product. In some situations, we may decline the changes if they would conflict with other inflight development efforts or really should be deferred until we can refactor pieces of the code base to ensure the features work in the long term.
For bug fixes, simply create an issue through GitHub to notify the team and chat about the design of the fix.
In order to speed up the process of accepting your contributions, you should try to make your pull request (PR) as small as possible, avoid any unnecessary deltas like whitespace formatting, and be sure to keep your change close to master to avoid merge conflicts.
####Third party libraries External libraries of the PowerBI-Visuals project are located in folders:
- "\src\Clients\Externals\ThirdPartyIP" - this folder contains main third party libraries used in this project
- "node_modules" folders - these folders contain plugins used by gulp build system.
Some libraries are licensed in a way that prevents us for shipping them in our production environment. So we might decline your pull request should that happen. If your contribution changes require adding or modifying a new 3rd party library, then you should contact the Power BI team first and get approval for it. Submit an issue clearly identifying the library and version to start the process. This process takes at least 3 weeks for internal review.
####Pull Request Checklist Pull Requests need to adhere to the checklist below. The Power BI team may ask you to make changes before accepting your changes.
All changes should follow our adopted coding guidelines. A detailed description of our coding guidelines can be found here.
Our project is localized – it means that we support multilingual text content. That’s why all text strings that will be added/changed into the project should be localized in the separate resource file.
When you change existing features or add new ones to the common themes and styles adhere existing styling of these files. Do not create a specific theme or style file that will be used only for your change. See the wiki documentation here.
Please follow our minimum requirements for implementing a new visual. See the wiki here.
All changes in the code will be reviewed by the Power BI team for common security and privacy issues. None of any components of the project can do network calls to resources placed outside the Power BI domain. No data can be downloaded outside, no external content can be shown anywhere inside the domain.
The Power BI team will review key performance metrics including initial load time, resize performance, property change time, linear performance with respect to data volume. See our Performance guidelines wiki here.
The code you submit should be licensed under the MIT license as we have done for the rest of the repo. If you use code that you did not author (like from Stack Overflow), you need to ensure correct attributions and license statements are made for those code blocks. Please work with us if you have questions.
List of supported browsers is here.
Your changes should pass all unit tests. So before submitting a pull request build the project and run the tests using gulp build system. Changes that cause tests to fail will not be reviewed or modified by approvers.
New functionality also should have appropriate unit tests for that functionality included in the pull request.
Every pull request should include detailed description of the change and should contain:
- Purpose of the change
- Description of functionality that was changed
- Bugs/issues details, if pull request fixes it
Wow you made it to the bottom! We’re looking forward to seeing what amazing contributions you provide and to helping you get them checked into the repo.
Thanks!
-The Power BI Team