Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 2.57 KB
Raw

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

  1. Fork and clone the repository

  2. Create a new branch: git checkout -b my-branch-name

  3. Make your changes, ensure that they include steps to install and validate post-install (e.g. kind.sh).

    Adding tool for Windows images:

    • add tool installation script Install-ToolName.ps1 (/images/win/scripts/Installers)
    • add tool validation script Validate-ToolName.ps1 (the same directory)
    • add changes to document tool name and version to the software report generator: images/win/scripts/SoftwareReport/SoftwareReport.Generator.ps1 that is used to generate software README file, e.g. Windows2019-Readme.md

  4. Test your changes by creating VHD and deploying a VM.

  5. 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. If it's a new piece tool being installed, consider cross-platform. If the tool is available in other platforms (MacOS, Windows, Linux), make sure you include it in as many as possible.
  • 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.

Resources