diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 99b3c98..b290aae 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -2,11 +2,11 @@ [fork]: https://github.com/actions/partner-runner-images/fork [pr]: https://github.com//actions/partner-runner-images/compare -[code-of-conduct]: CODE_OF_CONDUCT.md +[code-of-conduct]: CODE_OF_CONDUCT.MD 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](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [MIT](LICENSE.md). +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [MIT license](LICENSE.txt). Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. @@ -14,28 +14,15 @@ Please note that this project is released with a [Contributor Code of Conduct][c 1. [Fork][fork] and clone the repository 1. Create a new branch: `git checkout -b my-branch-name` -1. Make your changes, ensure that they include steps to install, validate post-install and update software report (please see [How to add new tool](CONTRIBUTING.md#how-to-add-new-tool) for details). -1. Test your changes by [creating VHD and deploying a VM](docs/create-image-and-azure-resources.md). +1. Make your changes. +1. Test your changes. 1. Push to your fork and [submit a pull request][pr] 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](https://github.com/PoshCode/PowerShellPracticeAndStyle) when writing Windows scripts. There is currently no set style for the Shell scripts that run Linux installs :soon:. - 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](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). -- For new tools: - - Make sure that the tool satisfies [Software Guidelines](README.md#software-guidelines). - - Create an issue and get an approval from us to add this tool to the image before creating the pull request. - -## How to add new tool -### General rules -- 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 - ## Resources diff --git a/README.md b/README.md index 23df397..c170f07 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ Any workflows that run on a partner image do not fall under the customer [SLA](h ## How to Interact with the Repo - **Issues**: To file a bug report, or request tools to be added/updated, please [open an issue using the appropriate template](https://github.com/actions/partner-runner-images/issues/new/choose) -- **Discussions**: If you want to share your thoughts about image configuration, installed software, or bring a new idea, please create a new topic in a [discussion](https://github.com/actions/partner-runner-images/discussions) for a corresponding category. Before making a new discussion please make sure no similar topics were created earlier. - For general questions about using the runner images or writing your Actions workflow, please open requests in the [GitHub Actions Community Forum](https://github.community/c/github-actions/41). ## FAQs