Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the MIT.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

Fork and clone the repository
Create a new branch: git checkout -b my-branch-name
Make your changes, ensure that they include steps to install, validate post-install and update software report (please see How to add new tool for details).
Test your changes by creating VHD and deploying a VM.
Push to your fork and submit a pull request

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

Follow the style guide for Powershell when writing Windows scripts. There is currently no set style for the Shell scripts that run Linux installs 🔜.
Include complete details of why this is needed in the PR description.
Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Write good commit messages.
For new tools:
- Make sure that the tool satisfies Software Guidelines.
- Create an issue and get an approval from us to add this tool to the image before creating the pull request.

For every new tool add validation scripts and update software report script to make sure that it is included to documentation
If the tool is available in other platforms (macOS, Windows, Linux), make sure you include it in as many as possible.
If installing a few versions of the tool, consider putting the list of versions in the corresponding toolset.json file. It will help other customers to configure their builds flexibly.
Use consistent naming across all files
Validation scripts should be simple and shouldn't change image content