MSIX Toolkit
MSIX Toolkit is a combination of tools and scripts focused on assisting IT pros and developers to make their app package modernization journey smoother. The toolkit will be open sourced on GitHub to allow customers and enthusiasts to contribute directly and provide suggestions and feedback on the content that is available.
The goal of the toolkit is to make it a gathering place for customers working with MSIX packages to come and find the help and assistance they need to build, manage, troubleshoot them.
Principles
- MSIX toolkit is a community led space where customers can freely contribute source code along with binaries and executables
- Users can’t post artifacts that don’t have a corresponding source code unless they are redistributables (discussed in more detail later in the doc).
- Till enough community involvement, a Microsoft employee will oversee making the decision to accept a pull request into the GitHub master branch.
- All contributed source code will need to include a readme file with detailed instructions on the setup and how to build the source code
Posting source code
Source code in the master branch will need to adhere to the following guidelines:
- The source code needs to compile
- The source code needs to compile into consumable binaries or executables with an entrypoint
- The code quality will need to adhere to common coding standards
- Microsoft curator will provide the feedback to contributors on any pull request on the changes that are required to accept their contribution
Posting consumable binaries or executables
- Contributors are encouraged to also add the built binaries, so that users can directly consume them as compared to requiring them to compile the source code.
- By having access to the source code along with the built binaries, users can validate their scenarios and if they are not met – they can contribute back to the source code to add support for their scenarios.
How to contribute
MSIX toolkit GitHub repository will accept external contributions via pull requests from a fork.
This article goes through the process of what an external contributor will need to go through to create a pull request - https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
Before we can accept a pull request from you, you'll need to sign a Contributor License Agreement (CLA). It is an automated process and you only need to do it once.
To enable us to quickly review and accept your pull requests, always create one pull request per issue. Similarly, if it’s a new tool or script, create individual pull requests per tool or script. Keep the pull requests as small and contained to a scenario as possible.